Topic-based documentation
One of the older digital documentation techniques is “topic-based.” As far as I am aware, perhaps one of the most well-known examples of documentation that uses this methodology is the AWS documentation (https://docs.aws.amazon.com/index.html). This technique breaks documentation into discrete “topics” that cover a task.
For example, the Monito Getting Started guide, Which Chapter 1 started looking at in, in the Looking at an example section, could contain the following topics:
- Choose an SDK
- Register an account
- Get an authentication key
- Use an authentication key with an SDK
- Add an SDK to your project
- Make a call with the SDK
And so on.
When displayed as an unordered list, this doesn’t show you the unique point of topic-based documentation. Each of these topics is (essentially) a separate file, or at least a separate section in a file, depending on the tool you use. To create documentation...
