A modern Documentation model proposed by Fabrizio Ferri Benedetti, see Blog: Passo Uni. The actions are similar to typical documentation Topics.
The 7 actions in detail:
- Appraise (Discern)
- Understand (Learn)
- Explore (Discover)
- Practice (Train)
- Remember (Recall)
- Develop (Integrate)
- Troubleshoot (Solve)
Actions and Content Types:
| Action | Topic types | DITA elements |
|---|---|---|
| Appraise | Overview, Product description, Service description | <topic>, <concept> |
| Understand | Conceptual guide, Explanation, Glossary | <concept>, <glossentry>, <section> |
| Explore | Quick start, Tutorial, Sandbox, Lab | <task>, <step>, <substep> |
| Practice | How-to guide, User guide, Tutorial | <task>, <step>, <choicetable> |
| Remember | API reference, Command reference, Glossary | <reference>, <refsyn>, <properties> |
| Develop | Integration guide, Development guidelines, Style guide | <task>, <codeblock>, <coderef> |
| Troubleshoot | Troubleshooting, Error reference, Optimization guide | <troubleshooting>, <trouble>, <cause>, <remedy> |
Sample Structure
- Feature one
- Overview (Appraise)
- Quick start (Explore)
- Concepts of
<feature> - Tutorials (Practice)
- Tutorial one
- Tutorial two
- Settings (Remember)
- Troubleshooting
- Feature two…
- API reference (Remember)
- Build your add-on (Develop)