1 / 12

Review of Authoring Subsystem

This presentation reviews the current authoring subsystem and proposes improvements for creating Interactive Electronic Technical Manuals (IETMs). It covers requirements, use cases, activity diagrams, object model, and major open issues.

ebryan
Download Presentation

Review of Authoring Subsystem

An Image/Link below is provided (as is) to download presentation Download Policy: Content on the Website is provided to you AS IS for your information and personal use and may not be sold / licensed / shared on other websites without getting consent from its author. Content is provided to you AS IS for your information and personal use only. Download presentation by click this link. While downloading, if for some reason you are not able to download a presentation, the publisher may have deleted the file from their server. During download, if you can't get a presentation, the file might be deleted by the publisher.

E N D

Presentation Transcript

  1. Review of Authoring Subsystem Anthony Yip Daniel Gindikin David Guttendorf Grace Ritter Jon Rosenberg Roger Hong Roger Smith Software Engineering 15-413 October 26, 1999

  2. Outline of this Presentation • Current System vs. Proposed System • Requirements • Overview of Use Cases • In Depth look at the IETM-ize Use Case • Activity Diagrams • Object Model • The Amazing Document Object • Major Open Issues Software Engineering 15-413 October 26, 1999

  3. All paper Authored by manufacturers and assemblers. Annotations as memos New versions Expensive Standardized IETMs “Black Box” model Stages of a Document Digital Document IETM Quality Control Electronic Annotations Current System vs. Proposed System Current System: Proposed System: Software Engineering 15-413 October 26, 1999

  4. Requirements • Core Requirements • Convert Technical Manuals into IETMs • Allow for Annotations to the IETMs • Quality Control • Additional Requirements • Know thy user (ease of use). • Networked PC capable of running the required software • Adequate storage space. IETMs can get rather large. • Version Control System (special thanks to Workflow) • System modularity • The network should be both reliable and secure Software Engineering 15-413 October 26, 1999

  5. Digitize Document Distribute Scanning Task Edit Digital Document Edit IETM IETM-ize Issue Annotation Merge IETM Verify Digital Document Verify IETM View IETM Overview of the Use Cases (10) 7 plus or minus 2… …for large values of 2 Software Engineering 15-413 October 26, 1999

  6. In-Depth Look: IETM-ize Software Engineering 15-413 October 26, 1999

  7. Hello! My name is: Paper Document Your journey begins here. Paper Document Sections Digital Document With Annotations Digital Document I get examined by a Quality Controller IETM Section With Annotations IETM Section So Do I Hello! My name is: IETM IETM With Annotations Non-Approved IETM If there are no errors Hello! My name is: Modification to IETM Activity Diagram Becomes Many Scanned and OCR’d by the Document Specialist If There Are Errors Document Specialist Corrects If There Are No Errors Converted by the Technical Writer If There Are Errors Technical Writer Corrects If there are No Errors Merge Manager Merges all relevant sections If There Are Errors Technical Writer Corrects Software Engineering 15-413 October 26, 1999

  8. Object Model • Joint effort with Workflow • We deal only with Documents • Workflow owns the parent class • And now, for your viewing pleasure… Software Engineering 15-413 October 26, 1999

  9. Document • 0..* Associated Document 1 Authoring Document 1 1 State Machine Annotations Digital Document IETM Section IETM 1 1 1 1..* The Amazing Document Object Software Engineering 15-413 October 26, 1999

  10. Major Open Issues • Dependencies and What We Will Provide • Workflow, Workflow, Workflow. • We will provide IETMs and a means by which to view them. • Access to the IETMs will be achieved through Workflow’s Database. • Other Issues • AIMSS 4.0 and ACS are not compatible. • We’re still looking for new OCR software that provides the same functionality as ACS. Software Engineering 15-413 October 26, 1999

  11. Summary • The Authoring Subsystem will provide a means to convert a Technical Manual into an IETM. • The system will be usable by those without training specific to the Technical Manuals or the existing authoring process. Software Engineering 15-413 October 26, 1999

  12. Now, it’s time for your… Questions and Comments! Software Engineering 15-413 October 26, 1999

More Related