Back to Developer Roadmap

Documentation Structure

src/data/roadmaps/technical-writer/content/[email protected]

4.0961 B
Original Source

Documentation Structure

The documentation structure refers to the arrangement and organization of information within the documentation. It should offer an intuitive and logical user navigation to facilitate quick comprehension and locate vital information effortlessly. The structure usually includes sections such as Overview, explaining the product and its issues it solves. Getting Started or Quick Start Guide offers initial information about using a product right away. Tutorials provide a step-by-step guide to completing a particular task. How-to guides solve a problem or accomplish specific user goals. Concept guides offer deeper understanding about the product's functionality while API/SDK Documentation contains code-based information. Lastly, Reference Manuals or User guides provide comprehensive details of the product’s functionality. The structure may vary depending on the type of product/service.