技术文档和产品帮助中心

我编写人们实际阅读的技术文档和产品帮助：用户指南、帮助中心、API参考。工作从拆解产品开始。我像新手一样逐步进行，记录下每个卡住的地方，并收集用户实际遇到的任务。这些任务构成了结构，而不是你的菜单树：首先是启动和第一个小胜利，然后是日常工作，最后是少数人需要但占用大部分支持团队时间的复杂场景。

每篇文章都是带有截图的步骤集合，配有说明，以便读者不必猜测哪个按钮是指的。一个单独的部分涵盖常见错误及其解决方法：屏幕上的文本、背后的原因、解决办法。API部分为每种方法提供请求和响应示例，解释字段和状态码，并清楚地说明失败时返回的内容。术语表将产品术语集中在一个地方，以便界面、帮助和支持回复使用相同的词汇，简短的风格指南修正语气和措辞，使文本即使在其他人后续添加时也保持一致的声音。

每个指令都通过在实时产品上逐步验证；没有经过这种演练的开发者记忆中的内容不会进入帮助文档。示例中的密钥、令牌和测试凭据被替换为占位符。未完成功能的文档标记为草稿，绝不会被当作已完成。

— 产品演练和真实用户任务列表
— 从首次启动到高级场景的帮助结构
— 带有截图和说明的逐步指令
— 关于常见错误及其解决方法的部分
— 带有请求和响应示例的API参考
— 术语表以及简短的风格和语气指南
— 每个指令在实时产品上重新检查
— 以易于进一步编辑的格式交付的源文件