Skip to content

Commit 8b46653

Browse files
authored
Update hierarchy.md
1 parent 2bea0ca commit 8b46653

1 file changed

Lines changed: 46 additions & 12 deletions

File tree

_posts/hierarchy.md

Lines changed: 46 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,25 +1,59 @@
1-
Every company has its organization rules that reflects the established hierarchy. You should mirror this hierarchy to create a usefull documentation.
1+
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.
22

3-
## Internal vs External
3+
## Why Hierarchy Matters
4+
5+
1. **Faster Navigation** – Readers find what they need without digging through unrelated content.
6+
2. **Better Scalability** – As documentation grows, a logical structure keeps it manageable.
7+
3. **Reduced Duplication** – Clear separation prevents overlapping or repeated information.
8+
9+
## How to Apply Hierarchy
410

5-
First you have to divide the documentation between internal and external but the internal documentation is directed to the workers and the external to the clients
11+
### 1. **Repositories & Folders**
12+
Group related documents in dedicated repositories or folders. Example:
613

7-
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.
14+
```
15+
📁 Documentation/
16+
├── 📁 Product-A/
17+
│ ├── 📄 Architecture.md
18+
│ ├── 📄 Deployment-Guide.md
19+
│ └── 📄 Troubleshooting.md
20+
├── 📁 Product-B/
21+
│ ├── 📄 User-Manual.md
22+
│ └── 📄 API-Reference.md
23+
└── 📁 Team/
24+
├── 📄 Onboarding.md
25+
└── 📄 Processes.md
26+
```
827

9-
### External documentation
28+
### 2. **Files & Sections**
29+
Break large documents into smaller, logical sections with clear headings. Example:
1030

11-
Companies should always delegate their communication to a especialized team using multiple steps to write, review and approve before publishing.
31+
```markdown
32+
# Project X Documentation
1233

13-
To reduce possible bottlenecks teams can be allowed to publish some types of communication like technical blocks or user manual but should follow strict rules to create a consistent communication.
34+
## Overview
35+
Brief description of the project.
1436

15-
### Internal documentation
37+
## Setup
38+
- Installation steps
39+
- Dependencies
1640

17-
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.
41+
## Usage
42+
- Common commands
43+
- Examples
44+
45+
## Troubleshooting
46+
- Known issues
47+
- Workarounds
48+
```
49+
50+
## Internal vs External
1851

19-
Ex: Imagine a configuration manual
52+
Divide the documentation between internal (directed to the workers) and the external (directed to the clients):
2053

21-
'''
22-
Li
54+
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.
2355

56+
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.
2457

58+
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.
2559

0 commit comments

Comments
 (0)