Based on feedback from previous users, I planned a document improvement
structure. like this,
Documentation
├── Getting Started Guide (for indexing and learning process guidance only)
│ ├── Platform installation
│ ├── Entry project
│ ├── Advanced Project
│ └── Solutions
│
├── Project A
│ ├── Project introduction
│ │ ├── What is it, what is solved
│ │ ├── Architecture analysis
│ │ └── Function introduction
│ ├── Quick start (only the simplest introduction)
│ ├── Detailed function (combination example)
│ │ ├── Create from zero
│ │ ├── Function 1
│ │ ├── Function 2
│ │ └── Function ...
│ ├── API / configuration query manual
│ ├── Efficiency tool (combined with reality)
│ │ ├── Tool A
│ │ ├── Tool B
│ │ └── Tool ...
│ ├── Experience reference (According to actual output, the following is
hypothetical content)
│ │ ├── Performance testing and tuning
│ │ ├── Suggestion for the production environment (function enablement,
upgrade plan, etc.)
│ │ ├── Troubleshooting
│ │ └── FAQ
│ ├── Development Guide
│ │ ├── Build from source code
│ │ ├── Module design
│ │ ├── Module A source code analysis
│ │ ├── Module B source code analysis
│ │ ├── Module ... source code analysis
│ │ ├── Coding conventions
│ │ └── Test case guidance
│ └── Operation and Maintenance Guide
│ ├── Management page introduction
│ ├── Function A
│ ├── Function B
│ └── Function ...
│
└── Project ...
└── ...
Do you have any thoughts?
