This is Chinese,
文档
├── 入门指引（仅做索引和学习流程指导）
│ ├── 平台安装
│ ├── 入门项目
│ ├── 进阶项目
│ └── 解决方案
│
├── 项目A
│ ├── 项目介绍
│ │ ├── 是什么、解决了什么
│ │ ├── 架构解析
│ │ └── 功能简介
│ ├── 快速入门（仅做最简单的启动介绍）
│ ├── 功能详解 （结合示例）
│ │ ├── 从零创建
│ │ ├── 功能1
│ │ ├── 功能2
│ │ └── 功能...
│ ├── API/配置查询手册
│ ├── 效率工具 （结合实际）
│ │ ├── 工具A
│ │ ├── 工具B
│ │ └── 工具...
│ ├── 经验参考 （按实际输出，以下为假设内容）
│ │ ├── 性能测试与调优
│ │ ├── 生产环境建议（功能启用、升级方案等）
│ │ ├── 故障排查
│ │ └── 常见问题
│ ├── 开发指南
│ │ ├── 源码构建
│ │ ├── 模块设计
│ │ ├── 模块A源码解析
│ │ ├── 模块B源码解析
│ │ ├── 模块...源码解析
│ │ ├── 编码规范约定
│ │ └── 测试用例指导
│ └── 运维指南
│ ├── 管理页面介绍
│ ├── 功能A
│ ├── 功能B
│ └── 功能...
│
└── 项目...
└── ...
victor chan <[email protected]> 于2019年11月28日周四 下午2:26写道：
> 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?
>
