More Related Content
Similar to Let's Start a Doc Project using DITA and CMS
Similar to Let's Start a Doc Project using DITA and CMS (20)
Recently uploaded
Recently uploaded (20)
Let's Start a Doc Project using DITA and CMS
- 1. Let’s Start a Documentation Project Proprietary & Confidential INC-1 (Public) A known fact; publicly available information; if compromised, it will have no bearing upon the business function / gain to another entity / financial loss to organization / loss of organization’s image or market value.
- 2. Agenda • The Deliverables • The Content Components • The Folder Structure • The Add-ons • The Outputs 2
- 4. 4 The Deliverables - Guides • Confirm the deliverables that need to be provided in the release Release Notes Installation Guide User’s Guide
- 5. 5 The Deliverables - Formats • Confirm the delivery formats PDF HTML Help CHM
- 6. 6 The Deliverables - Example • A product named Widget by Example Corporation is having its first release. • The commissioned deliverables are: – Example Widget Release Notes – Example Widget Installation Guide – Example Widget User’s Guide • The commissioned delivery formats are: – PDFs (for all guides) – CHMs (only for User’s Guide) – HTML Help (one output integrating all guides)
- 9. 9 The Content Components Description Content Component Content Type Description Variables Library Topic A placeholder for names that might change during the lifecycle of a release, or future releases. Images Image Media files in formats like JPG, PNG, GIF, etc. Topics Topic Topics contain all the content and are of three types: Concepts, Tasks, or References. Maps Map Maps are placeholders for all the topics part of a release. Also acts as the TOC of the guide. Publications Publication Publications contain all components of a project/guide. It is used for generating multiple outputs using a single source.
- 10. 10 The Content Components Relationship Publication Map Topics Variables / Images
- 12. 12 The Folder Structure • The folder structure shows where your product folder resides within the CMS. • The folder structure organizes the content components of the product within the repository. • The folder structure has to be consistent for all products in the CMS.
- 13. 13 The Skeletal Folder Structure Main Folder Product Suite 01 Product 01-01 Product 01-02 Product Suite 02 Product 02-01 Product 02-02
- 14. 14 The Folder Structure - Example Example Corp Micro Tools Notes Sketches Nano Tools Gestures Biometrics
- 15. 15 The Folder Structure – Folder Type Folder Name Folder Type Example Corp None • Micro Tools None • Notes None • Sketches None • Nano Tools None • Gesture None • Biometrics None
- 16. 16 The Folder Structure – Shared Components Example Corp Micro Tools Shared Components Notes Sketches Nano Tools Shared Components Gestures Biometrics
- 17. 17 The Folder Structure – Folder Type Folder Name Folder Type Example Corp None • Micro Tools None • Shared Components None • Notes None • Sketches None • Nano Tools None • Shared Components None • Gestures None • Biometrics None
- 18. 18 The Folder Structure – Shared Components Example Corp Micro Tools Shared Components Images Topics Maps Notes Sketches Nano Tools Shared Components Images Topics Maps Gestures Biometrics
- 19. 19 The Folder Structure – Folder Type Folder Name Folder Type Example Corp None • Micro Tools None • Shared Components None • Images Image • Topics Topic • Maps Map • Notes None • Sketches None • Nano Tools None • Shared Components None • Images Image • Topics Topic • Maps Map • Gestures None • Biometrics None
- 20. 20 The Folder Structure - Widgets Example Corp Micro Tools Shared Components Images Topics Maps Notes Sketches Widgets Nano Tools Shared Components Images Topics Maps Gestures Biometrics
- 21. 21 The Folder Structure – Folder Type Folder Name Folder Type Example Corp None • Micro Tools None • Shared Components None • Images Image • Topics Topic • Maps Map • Notes None • Sketches None • Widgets None • Nano Tools None • Shared Components None • Images Image • Topics Topic • Maps Map • Gestures None • Biometrics None
- 22. 22 The Folder Structure – Widgets Folder Widgets Variables Images Topics Maps Publications
- 23. 23 The Folder Structure – Folder Type Folder Name Folder Type Widgets None • Variables Library Topic • Images Image • Topics Topic • Maps Map • Publications Publication
- 24. 24 The Folder Structure – Common Folders Widgets Front Matter Shared Variables Images Topics Maps Publications
- 25. 25 The Folder Structure – Folder Type Folder Name Folder Type Widgets None • Front Matter Topic • Shared Components None • Variables Library Topic • Images Image • Topics Topic • Maps Map • Publications Publication
- 26. 26 The Folder Structure – Common Topics Widgets Front Matter Important Information Support Conventions Related Documents Shared Variables Images Topics Maps Publications
- 27. 27 The Folder Structure – Topic Type Folder Name Folder Type Widgets None • Front Matter None • Important Information Topic • Support Topic • Conventions Topic • Related Documents Topic • Shared Components None • Variables Library Topic • Images Image • Topics Topic • Maps Map • Publications Publication
- 28. 28 The Folder Structure – Shared Components Widgets Front Matter Shared Images Topics Variables Images Topics Maps Publications
- 29. 29 The Folder Structure – Folder Type Folder Name Folder Type Widgets None • Front Matter Topic • Shared Components None • Images Image • Topics Topic • Variables Library Topic • Images Image • Topics Topic • Maps Map • Publications Publication
- 30. 30 The Folder Structure – Shared Topics Widgets Front Matter Shared Images Topics Concepts Component Tasks Component References Component Error Messages Component Variables Images Topics Maps Publications
- 31. 31 The Folder Structure – Topic Type Topic Name Topic Type Concepts Component Concept Tasks Component Task References Component Reference Error Messages Component Concept/Reference
- 32. 32 The Folder Structure - Variables Widgets Front Matter Shared Variables Widgets Variables Images Topics Maps Publications
- 33. 33 The Folder Structure – Element Type Element Name Element Type Widgets Variables Library Topic
- 34. 34 The Folder Structure - Images Widgets Front Matter Shared Variables Images Release Notes Installation Guide User’s Guide Topics Maps Publications
- 35. 35 The Folder Structure – Folder Type Folder Name Folder Type Widgets None • Front Matter Topic • Shared Components None • Variables Library Topic • Images Image • Release Notes Image • Installation Guide Image • User’s Guide Image • Topics Topic • Maps Map • Publications Publication
- 36. 36 The Folder Structure - Topics Widgets Front Matter Shared Variables Images Topics Release Notes Installation Guide User’s Guide Maps Publications
- 37. 37 The Folder Structure – Folder Type Folder Name Folder Type Widgets None • Front Matter Topic • Shared Components None • Variables Library Topic • Images Image • Topics Topic • Release Notes Topic • Installation Guide Topic • User’s Guide Topic • Maps Map • Publications Publication
- 38. 38 The Folder Structure - Maps Widgets Front Matter Shared Variables Images Topics Maps Release Notes Installation Guide User’s Guide Widgets Publications
- 39. 39 The Folder Structure – Element Type Element Name Element Type Release Notes Map Installation Guide Map User’s Guide Map Widgets Map
- 40. 40 The Folder Structure - Publications Widgets Front Matter Shared Variables Images Topics Maps Publications Release Notes Installation Guide User’s Guide Widgets
- 41. 41 The Folder Structure – Element Type Element Name Element Type Release Notes Publication Installation Guide Publication User’s Guide Publication Widgets Publication
- 42. The Add-ons 42
- 43. 43 The Add-ons • Use the Conditional Manager to set up the conditions required for the project – Mac / Windows – HTML / PDF • Use the Translation Tool to set up translation process
- 44. The Outputs 44
- 45. 45 The Outputs • Using a single source file to generate multiple outputs • Outputs like PDF, CHM, HTML, etc., can be generated • Apply conditions before generating the necessary output • Use draft markers and watermark at review stage and remove them before generating the final output
- 46. CONTACT Mayur Madhav Bhandarkar | +91 932 421 1347 | mayur.bhandarkar@incedoinc.com Thank You. 46