- The main “Docs” page will list the names of all the products (or items) that you have written documentation for. Clicking on a product will take you to the docs only for that product.
- A product page: Each product page organized into sub-sections. Examples of sub-sections are “Installation”, “Options”, “Usage”, or “Troubleshooting”. (You will create your own sub-sections, as needed to fit your docs.) Under each sub-section, there is a list of each individual documentation article in that sub-section. Example of one product page:
Clicking on one of those titles will take you to that single doc article.
- The single docs articles (single posts) will have a Table of Contents added to the sidebar. This Table of Contents only includes docs pertaining to the product which the current single doc belongs to. Example of a single doc article:
- The pages described in number 2 and 3 above are topped with the Docs Menu Bar. This is a dynamic menu that lets you click on sub-sections of whichever product is being viewed. Clicking on a sub-section takes you to a page that lists each individual documentation article in that sub-section. Clicking on one of those titles will take you to that single doc article. The Docs Menu Bar lets you quickly navigate between sub-sections of one product’s docs. You can see the Docs Menu Bar in the pictures above, directly under the product title, “Software Product 2”.
Organized Docs WordPress Plugin
Updated on March 5, 2017