Hierarchy

A well-structured hierarchy helps users navigate documentation efficiently. Just like a well-organized folder system, a clear hierarchy reduces confusion and speeds up information retrieval.

Why Hierarchy Matters

1. Faster Navigation – Readers find what they need without digging through unrelated content.
2. Better Scalability – As documentation grows, a logical structure keeps it manageable.
3. Reduced Duplication – Clear separation prevents overlapping or repeated information.

How to Apply Hierarchy

1. Repositories & Folders

Group related documents in dedicated repositories or folders. Example:

📁 Documentation/  
├── 📁 Product-A/  
│   ├── 📄 Architecture.md  
│   ├── 📄 Deployment-Guide.md  
│   └── 📄 Troubleshooting.md  
├── 📁 Product-B/  
│   ├── 📄 User-Manual.md  
│   └── 📄 API-Reference.md  
└── 📁 Team/  
    ├── 📄 Onboarding.md  
    └── 📄 Processes.md  

2. Files & Sections

Break large documents into smaller, logical sections with clear headings. Example:

# Project X Documentation  

## Overview  
Brief description of the project.  

## Setup  
- Installation steps  
- Dependencies  

## Usage  
- Common commands  
- Examples  

## Troubleshooting  
- Known issues  
- Workarounds  

Internal vs External

Divide the documentation between internal (directed to the workers) and the external (directed to the clients):

The External documentation are an important part to the company marketing, sales and support. It should be treated with a high degree of precision and politeness otherwise it can hurt company’s image. Companies should always delegate their communication to a especialized team using multiple steps to write, review and approve before publishing.

To reduce possible bottlenecks teams can be allowed to publish some types of communication like technical blocks or user manuals but should follow strict rules to create a consistent communication.

The Internal documentation can be less strict in terms of precision or completeness. You can use pictures, videos, emojis and other informal elements but you should always be polite and respectful to keep things professional.