What Are The Components Of A Complete Technical Documentation Solution?
IETM / IETP technical documentation solutions are intricately wrought, possessing features applicable to specific tasks related to information management. They can have multiple components, each with a unique purpose that addresses requirements in the aviation industry workflow ecosystem. A Viewer application dedicates itself to displaying informational content, and assists with its manipulation through the usage of tools contained within it. A Self-Serve Portal is largely about access and authorization to view data, permitting users with the correct rights to consume information through an IETM / IETP Viewer. But where does this organized content and information come from?
An application is required to author and manage the masses of data necessary to perform tasks in aviation. Web based portals are the usual point of access to these applications, but access is not limited to that medium alone. These powerful apps are designed to maintain consistency and alignment of all data being used. They are also highly useful in the implementation of certain informational structuring standards, like the S1000D standard, for example. The S1000D standard requires data to have certain characteristics, which allow its reuse, updating and alteration while maintaining compliance to regulations. The component is called a Publisher, or, as in the NIVOMAX Suite, the Builder.
What Is The Function Of A Builder?
The Builder, simply put, is the creator, when compared to other components in a technical documentation suite. The data consumed by aviation stakeholders is often authored with XML (Extensible MarkUp Language), particularly with organizations using an S1000D standard or specification. Information needs to be structured to include attributes, such as UTF encoding, version, the status of the information (i.e. new, revised , unchanged) and include various denotations of taxonomy, titles, applicability notes and more. These details allow the Builder to recognize characteristics of the data, and apply changes or modifications easily for optimal organizational structuring and usage.
With the information in XML format, Builders are the key component that converts this data laden XML content into an HTML format, one that can be easily consumed by users viewing through an IETM / IETP Viewing application, rendered through a web browser. While the XML defines the content, through tags,, another part, the metadata, is also converted. Metadata is the internal elements” of the data, which allow search engines to find specifically requested information. Style sheets are the last part, which allow the information to be displayed on the various devices that people use to view it. In S1000D, in order to author data compliant with the specifications guideline, all of the above and more needs to be executed. They form a basic element in S1000D called a Schema, a small set of elements that suit a specific purpose, and are given a name.
Technical documentation also needs to be transformed further. In order to display efficiently in an IETM / IETP viewing application, the data must go through another process. To author well organized content, especially when applying an S100D standard or specification, information must be indexed, indicating chapters and sections within the publication or manual. It also needs to be validated, to ensure it contains all the necessary elements existing in its structure. These requirement elements can be graphics or tables, which have their own process related to incorporating them into the final content prior to indexing and validation.
What Does All This Detail Do For You?
The ability of the Builder application to author such granular elements into its content has a definite purpose. Technical documentation utilized through an IETM / IETP is meant to be, as a business standard, reused and maintained in a current state. This means it includes the latest information available, be it regarding safety or other procedural regulations. The Builder component allows companies to build Virtual Libraries, which can be organized according a a standard that accommodates and adheres to internal needs and various compliancy parameters.The S1000D standard was created exactly for this purpose, and many organizations use it, or methods speaking to its unique structure, for optimized information management.
For example, an author may create technical documentation that speaks to maintenance for landing gear, for which, there is a critical update required. There could be multiple models of aircraft, which possess the same type of parts contained in manuals throughout various virtual libraries. The Builder application permits the alignment of all information relating the specific landing gear to be updated and harmonized across the entire Virtual library structure available to be accessed through the IETM /IETP Viewer by any user. Conversely, erroneous data can be deleted or rolled back to another version if necessary, aligning in every library that contains the updated or deleted content. By this method, compliance and unified data can be assured for safe and concise implementation in all workflows, avoiding errors and dangerous hazards.
Approaching Your Informational Requirements
IETM / IETP components have great value when utilized correctly. Implementing an S1000D standard or specification is an undertaking that requires planning and, or course, a knowledgeable partner to guide you in implementing the application or applications. Your ability to author, view and access these components requires forethought in order to render a strategy that speaks to a company’s most intrinsic needs. The NIVOMAX Builder and its companion components have the ability to assist enterprise grade requirements for the aviation community. If you have questions, reach out to us and request a demo of our products.