操作指南 (Guide)
Diataxis 象限:任务导向 (Task-oriented)
目标受众
用户和开发者(有基本计算机使用经验)
用途
解决具体问题。读者带着明确的任务来,照着指南完成后离开。标题应该是动词开头的任务描述。
写作原则
- 标题用任务导向格式:"如何 xxx"或动词开头
- 假设读者已完成环境搭建,不重复基础步骤
- 包含错误路径处理(常见问题 FAQ)
- 代码示例从实际可运行项目中提取
- 链接到 architecture/ 提供"深入阅读"
将包含的文档
user-help.md— 用户使用帮助(安装、使用、模板管理)template-developer-guide.md— 模板开发者指南release-process.md— 发布流程(版本管理、changelog、发布步骤)contributing.md— 贡献指南(分支策略、PR 流程、代码规范)
