技术文档工程师
Tech Writer
这个技能是什么
写代码虽然爽,但写文档绝对是很多开发者的噩梦。这个技能就是把 AI 变成你的“文档助手”,你只需要把实现功能的粗糙步骤(比如:点这里 $\rightarrow$ 输入那个 $\rightarrow$ 重启)丢给它,它就能帮你扩充成一篇逻辑通顺、语气自然、用户能读懂的正式操作指南。它最强的地方在于能自动识别哪里需要配图,并帮你预留好 (截图) 占位符,省去了你反复思考怎么组织语言的痛苦。
适用场景
- 快速给新功能写一份 User Guide,发给产品经理或客户确认。
- 把混乱的开发笔记整理成规范的 README 或 Wiki 页面。
- 为开源项目编写快速上手指南(Quick Start),降低新用户的上手门槛。
- 将复杂的 API 调用流程转化为易懂的步骤说明。
如何使用
你只需要把功能实现的简易步骤发给 AI。如果你想让它写得更专业,可以直接复制下面这段提示词作为对话的开始:
markdown
你现在是一名资深的 Technical Writer。我会给你提供一个软件功能的简单操作步骤,请你基于这些碎片信息,将其扩展成一篇具有引导性、易读且专业的实操指南。
要求如下:
1. 语气要自然且具有引导感,不要像说明书那样死板,要让用户觉得在被引导完成任务。
2. 结构清晰,使用标题、步骤列表等方式组织内容。
3. 在你认为需要配图以辅助理解的地方,直接插入 (截图) 占位符,方便我后续补图。
待处理的初步步骤如下:
"[在此处替换成你的具体步骤,例如:1.点击下载按钮 2.安装文件 3.双击打开]"
使用技巧
- 提供用户画像:在步骤后面加一句“用户是完全不懂技术的小白”或“用户是资深后端开发”,AI 会自动调整用词的深浅。
- 指定文档风格:如果你喜欢 Stripe 那种极简风,或者像 AWS 那种严谨风,直接告诉它,效果会更统一。
- 迭代优化:如果 AI 扩充的内容太啰嗦,你可以要求它“用更精炼的祈使句重写”,这样文档会更有节奏感。
- 补充上下文:给步骤时顺便提一句这个功能的目的是什么,AI 能写出更好的前言,让用户明白为什么要这么操作。
注意事项
- 核对准确性:AI 可能会为了流畅度而“脑补”一些步骤,发布前一定要亲自跑一遍流程,确保步骤没写错。
- 术语统一:如果你的产品里有特定的专有名词(比如把“用户中心”叫“控制面板”),记得在输入步骤时明确告知,避免 AI 使用通用词汇导致混淆。