1. 核心原则

  • 清晰导航:使用层级目录(如 /docs/structure/intro)帮助用户快速定位内容
  • 模块化设计:每个文档应聚焦单一主题,避免信息过载
  • 一致性:保持标题格式(#/##/###)、术语和排版风格统一

2. 实践建议

  • 使用 ## 作为二级标题,### 作为三级标题
  • 重要概念添加 📘 图标标注
  • 每个章节结尾建议添加扩展阅读链接,例如:查看完整文档结构指南

3. 图片示例

technical_writing
documentation_structure

4. 工具推荐

  • Markdown 编写规范 工具集
  • 使用 ![](https://cloud-image.ullrai.com/q/...) 语法插入示意图
  • 推荐使用 ### 分隔小节,提升可读性

本指南遵循 文档结构最佳实践 的核心理念,帮助开发者构建高效的知识体系