Presentation on theme: "Configuration-Based Documentation Authoring Step Up From the Topic-Oriented Approach."— Presentation transcript:
Configuration-Based Documentation Authoring Step Up From the Topic-Oriented Approach
The Topic-Oriented Approach Tools Benefits Troubles Lets talk about it.
Everything about Text Set Of Docs Structure Consistency!
Case 1: Multiple Models, Multiple Docs User Manual Map 1 Script 1 Map 2 Script 2 Topics User ManualQuick Start MS WordDITA, AuthorIT, etc. Main script
The Copy/Paste Monster Strikes Back Model N Model 2 Model 1 2 N document maps 2 N document-related scripts 2 N command lines in the main script Copy! Paste!
Use CMDB to Generate Maps and Scripts User Manual Quick Start Reference Unified Templates ModelDoc TypeFormat Model 1User ManualPDF Model 1Quick StartPDF Model 1ReferenceHTML Model 2User ManualPDF ……… CMDB Converters PDFHTML
Go into Details User Manual Map: Model 1, User Manual CMDB.XSL.XML PDF Model_1-Intro Model-?-Intro Model-?-Install The CMDB script performs the transformation for every registered document.
Wrangle! Admire! Copy! Paste!
Case 2: Let the Bear Work! Generate automatically: Obvious linking text Descriptions of structures –Lists –Diagrams
Slice the Process ActorMotivationReactionResult Operator in a call-center A user reports a problem Report an incident to a Help Desk System The incident is registered Support team engineer The incident is registered Find a reason of the problem and fix it The problem is fixed ………… CMDB 1. … 2. … 3. …
Slicing Script CMDB Job Instructions Process Description Slicing Script