Reader small image

You're reading from  Technical Writing for Software Developers

Product typeBook
Published inMar 2024
PublisherPackt
ISBN-139781835080405
Edition1st Edition
Right arrow
Author (1)
Chris Chinchilla
Chris Chinchilla
author image
Chris Chinchilla

Chris Chinchilla spent years as a developer before switching to helping people understand code better instead of writing it. He has worked crafting documentation for many developer-focused projects, from small open-source projects to large and well-known tools and products, tackling everything from tooling to videos. He is known for bringing developers and writers closer with editor and automation-based tools. Outside of tech writing, he publishes fiction, YouTube videos, podcasts, and music. In short, he loves to communicate and find the best medium for the message.
Read more about Chris Chinchilla

Right arrow

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...

lock icon
The rest of the page is locked
Previous PageNext Page
You have been reading a chapter from
Technical Writing for Software Developers
Published in: Mar 2024Publisher: PacktISBN-13: 9781835080405

Author (1)

author image
Chris Chinchilla

Chris Chinchilla spent years as a developer before switching to helping people understand code better instead of writing it. He has worked crafting documentation for many developer-focused projects, from small open-source projects to large and well-known tools and products, tackling everything from tooling to videos. He is known for bringing developers and writers closer with editor and automation-based tools. Outside of tech writing, he publishes fiction, YouTube videos, podcasts, and music. In short, he loves to communicate and find the best medium for the message.
Read more about Chris Chinchilla