Medical Device PLM

Introduction to Medical Device PLM

Overview

Course Agenda

Agenda

  1. Terms
  2. Features
  3. User Interface
  4. Final Test

Overview

The Aras Technical Documentation Application (Tech Docs) is a content authoring tool, fully integrated into Aras Innovator PLM that collectively provides component content management capability for topics-based, modular documentation. Tech Docs 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, Aras Tech Docs leverages Innovator’s 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.

Terms

The following Terms are used throughout this document:

Term

Business Object

Definition

Refers to any Item in Innovator that contains information, which may be referred to in a Technical Document.


Cascading Style Sheets (CSS)

Industry standard text-based format for controlling the position, color, size, etc. of web-based content. It is used by the Technical Documentation application to control the format of HTML and PDF content.


Content Filters

Metadata (name/value pairs) that are defined by the Technical Document Administrator and chosen by the Technical Document Author to characterize Document Elements within a Technical Document.

Features

Structured Documents and Modules

Technical Documents can exists as a single entity - with all content contained within – or aggregate content from multiple document components. Breaking up documents into smaller components has multiple advantages including the ability to:

  1. Reuse each component,
  2. Enable concurrent editing, and
  3. Apportion each component to areas of specific specialty or expertise

In the Technical Publication domain, technical content is sometimes referred to as ‘Topics-based’ or ‘Modular’. This refers to content that is about a specific topic or area of focus and is, to some degree, context-insensitive. This helps to characterize the content and enable it to exist in multiple places within a document. Contrast this with a narrative in other forms of documents where every paragraph builds upon (and thus depends on) previous paragraphs and context.Each Technical Document instance can evolve independently and be protected by specific access rights. To be reusable, each document component needs to be constructed in a way that allows it to fit within a larger context. 

To achieve this, the content of each Document / Document Component will be based on an overarching schema or document structure (Section 3.1). This document structure helps ensure consistency and provides a mechanism for determining how individual components can fit into a larger context.

Document Content Styling

The style and layout of Technical Documents is dictated by a separate style configuration that is maintained separately but associated directly with a Technical Document Type definition. Each Document Element defined in the Schema can be referenced and have a unique set of styling parameters that are used to position and render the associated Document Element instances in each document. Style settings can be assigned to HTML output, PDF Output, and the Document Editor.

Referencing centrally-controlled style settings ensure consistency in look and feel for published content and provides a convenient mechanism to update style in one location and have it automatically apply to all associated documents.

Metadata

All Document Element content can additional metadata information assigned to provide additional semantics for content classification and aid in content search and retrieval. This metadata is provided by the Technical Document Author when the Document Structure is designed and configured.

User Interface

Overview

Authoring and viewing Technical Document content is done using the Technical Document Form.The Tear Off window for Items of type Technical Document has two views: Form and Editor. These Views are accessed using a sidebar menu displayed along the left of the window.

The Technical Document Editor contains three main panes: Toolbar, Navigation Pane, and the Content Viewer/Editor. The toolbar contains various buttons to invoke separate functions for viewing and content editing. The buttons exposed on the toolbar are context-sensitive; based on the currently selected Document Element. The navigation pane (sometimes called Structure Tree) displays individual ‘nodes’ each representing the hierarchy of Document Elements that comprise the document. Selecting the ‘+’ icon at various levels expands the tree by displaying all the child Document Elements. Selecting a node in the navigation pane will cause the corresponding content associated with that node to be scrolled and highlighted in the Content Viewer/Editor. The Content Viewer/Editor displays the content of the document and represents the canvas on which content is added and modified by the author. Selecting content in the editor/viewer will cause the corresponding Document Element node in the navigation pane to be scrolled and highlighted.

Final Test

Introduction

You are one step closer to getting the free trail. You need to pass the test and we will automatically send you a link with your credentials to the system. 

What is the test all about?

In the following section there will be few questions testing your understanding of the course content. 

Match the the definition with the term.

  • Business Object
    Refers to any Item in Innovator that contains information, which may be referred to in a Technical Document.
  • Cascading Style Sheets (CSS)
    Industry standard text-based format for controlling the position, color, size, etc. of web-based content. It is used by the Technical Documentation application to control the format of HTML and PDF content.
  • Content Filters
    Metadata (name/value pairs) that are defined by the Technical Document Administrator and chosen by the Technical Document Author to characterize Document Elements within a Technical Document.

What advanatages breakinf up documents into smaller components has?

  • Reuse of each component
  • Enable concurrent editing
  • Apportion each component to areas of specific specialty or expertise
  • Does not have any advanatages.

Select the "Toolbar" sections on a Technical Document page.

Place the mouse to the desired area and mark it.

Select the "Form" sections on a Technical Document page.

Place the mouse to the desired area and mark it.

Untitled scenario question

Thank you!

Great job! You compleated the course successfully.

You will recieve an email with information for your free trail session.