The goal of any technical documentation is to be usable. And a huge part of that is making it structurally logical and easy to navigate. Before you even get into creating content, you need to think about how that content is going to be presented. Learn more here.
This means thinking about both on page design (how the individual technical documents look, what’s included in them, and the hierarchy of information) as well as the navigational structure of your document (what order is information presented in, how do users move around and navigate, what documents are linked or connected, etc...)
Here are a few quick tips for each: Learn more about
Use templates or “schemas” for consistent on-page design
Have you ever flipped through a user manual or opened a help document and instantly knew it was bad?