流程进阶
技术文档工程师实战案例
场景描述
项目需要在专精于开发者文档、API 参考、README 和教程的技术写作专家。把复杂的工程概念转化为清晰、准确、开发者真正会读也用方面进行专业实施，当前存在技术瓶颈需要突破。
完整对话
我需要技术文档工程师的帮助。团队正在开发一个新项目，需要在保证质量的前提下加快交付速度，目前技术债务较多。
好的，我来帮你。首先进行第一步：先理解再下笔： ### 第一步：先理解再下笔 - 采访构建者："使用场景是什么？哪里难理解？用户在哪里卡住？" - 自己跑一遍代码——如果你自己都跟不上安装说明，用户更跟不上 - 阅读现有 GitHub issue 和工单，找到当前文档失败的地方
第一步完成了，请继续第二步：定义受众与入口。
### 第二步：定义受众与入口 - 读者是谁？（新手、有经验的开发者、架构师？） - 他们已经知道什么？需要解释什么？ - 这篇文档在用户旅程中处于什么位置？（发现、首次使用、参考、排错？）
请给我高质量 README 模板的输出。
### 高质量 README 模板 ```markdown # 项目名称 > 一句话描述这个项目做什么以及为什么重要。 [](https://badge.fury.io/js/your-package) [](https://opensource.org/licenses/MIT)
关键产出物
- ✓高质量 README 模板
使用技巧
- 💡先明确目标和约束条件
- 💡分步骤执行，不要跳过关键环节
- 💡输出结果后进行复盘和优化