Writing or organizing your documentation as topics is one way of structuring your content into separate 'blocks'.
What are Documentation Topics?
Writing or organizing your documentation as topics is one way of structuring your content into separate 'blocks'. It means that you end up with many separate pieces of information, instead of holding all of your content in one single file (say, in a Word document). With your documentation organized into topics, you can then build a system that works for you – such as a user guide – and include all of the relevant topics needed for that particular guide.
You could also say that a topic is a page of documentation that helps a user to accomplish a goal.
What are the Benefits of Categorizing Your Documentation into Topics?
There are many benefits to documenting your content as topics. As a tech writer, having structure makes it easy to create new content, as well as update existing content, and it also aids any content reuse efforts you might be working on. And for your users, they will easily be able to find the information they're looking for.
From the use of Confluence templates to adding media once you've defined your topics, the following pages will give you more information about exactly how you can make your documentation topics great.
Use templates in Confluence to create topic guidelines without restricting the writer's imagination.Create and Organize Content Dynamically
Make use of macros in Confluence to expand the capabilities of your pages and then add labels to quickly organize your documentation.Add Images and Videos
Quickly and easily add media to a Confluence page. Learn how to organize your images and videos, and maintain them over time to ensure consistency.Create and Update Diagrams
Use diagrams in Confluence to illustrate a complex process to help users more easily understand complex information.
Define Topic Types with Templates