Overview

The Technical Documentation Framework is a content authoring tool, fully integrated into Aras Innovator PLM that collectively provides component content management capability for topics-based, modular documentation. The editor enables users of various disciplines to author, visualize, share, and publish information all within a central, controlled, and collaborative environment. Unlike other systems that provide Document-level Management functions for content produced by external applications, the Technical Documentation Framework leverages the Aras Innovator core PLM functionality (Access Control, Workflow/Lifecycle, Change Notification, etc.) and provides a web-based authoring tool for creating content directly, embedding shared document components, or referencing other elements managed by the PLM system. So as related Documents, Parts, Project Tasks, Requirements, or any other information managed by Aras Innovator evolve through subsequent revisions, authors of technical documentation can be alerted and navigated to pending changes, or the system can update the related documentation automatically.

Technical Documents can be composed of individual components (sections, paragraphs, illustrations, tables, etc.), where each component can change independently; and optionally created/managed by multiple users. The aggregated information forms the complete published document. This Structured Content is specified by a user-defined data model that identifies the elements of each component, their relationships and cardinality, and any restrictions on data type and value limitations. The built-in authoring User Interface directs the author as to the types of document elements that can be inserted, constantly validating the document as it is created. Candidate documents for release can be routed through workflow and published on final acceptance.

This document describes the functions and features of the Technical Documentation Framework. It is meant to be a reference for the Technical Document Author as they use the software to author technical content. Section 1 provides an overview of the features of the software. Section 2 describes the User Interface. Section 3 describes how you use the software to create technical content. Section 4 describes how to publish/export content in various formats.