1 / 13

Advanced Configuration-Based Documentation Authoring Strategies

Learn the step up from the topic-oriented approach to configuration-based documentation. Explore benefits and tools, troubleshoot common issues, and master a structured set of documents for consistency. Discover how to manage multiple models and documents using tools like MS Word, DITA, and AuthorIT, and create user manuals, quick starts, and reference materials effortlessly. Utilize CMDB to generate maps and scripts using unified templates and streamline the documentation process.

bliss
Télécharger la présentation

Advanced Configuration-Based Documentation Authoring Strategies

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. Configuration-Based Documentation Authoring Step Up From the Topic-Oriented Approach

  2. The Topic-Oriented Approach Let’s talk about it. Benefits Tools Troubles

  3. Set Of Docs Structure Everything about Consistency! Text

  4. Case 1: Multiple Models, Multiple Docs MS Word DITA, AuthorIT, etc. User Manual User Manual Quick Start Map 1 Script 1 Topics Map 2 Script 2 Main script

  5. Model N Model 2 Copy!Paste! The Copy/Paste MonsterStrikes Back Model 1 2 • N document maps2 • N document-related scripts2 • N command lines in the main script

  6. CMDB Model Doc Type Format Model 1 User Manual PDF Model 1 Quick Start PDF Model 1 Reference HTML Model 2 User Manual PDF … … … UserManual Converters QuickStart PDF Reference HTML Use CMDB to GenerateMaps and Scripts Unified Templates

  7. PDF Go into Details Map: Model 1, User Manual CMDB Model_1-Intro .XML .XML .XML .XML UserManual .XML .XSL Model-?-Intro The CMDB script performs the transformation for every registered document. Model-?-Install

  8. Copy!Paste! Wrangle! Admire!

  9. Case 2: Let the Bear Work! Generate automatically: • Obvious linking text • Descriptions of structures • Lists • Diagrams

  10. Slice the Process CMDB 1. …2. …3. … 1. …2. …3. …

  11. JobInstructions Slicing Script Slicing Script CMDB ProcessDescription

  12. Kaboom!

  13. You are welcome! misha@philosoft.bizMikhail Ostrogorskij

More Related