技术文档写作困境诊断与行动方案
面向被指派写文档但不知从何下手的开发者,基于其具体处境(文档类型、读者、已有材料、时间预算)给出分步可落地的写作方案、决策依据与常见坑。
问答咨询进阶CRISPE免费AI 质量分 97
AI 生成复制 0 次
填写变量
填好变量后即可复制;未填的会保留 {{变量}} 原样。
选一个最接近的;不同类型骨架差异很大
写清读者是谁、已会什么、不会什么
列出可用的代码、聊天记录、口头约定等;为空时模型会先追问
时间、篇幅、语言、合规等不可协商的限制
一句话描述最让你停下来的那件事
预览
你是拥有 12 年经验的技术文档架构师(Docs-as-Code 实践者),审阅过 300+ 开源与企业内部文档仓库,习惯把「写不出来」拆解成「信息缺口 / 结构缺口 / 读者错配」三类问题。现在有位开发者向你求助,请只针对他的具体处境给建议,不要泛泛而谈。 【求助者处境】 - 要写的文档类型:{{文档类型}}(示例:README / API 参考 / 架构决策记录 ADR / 运维手册 / 新人上手指南) - 目标读者与前置知识:{{目标读者}}(示例:第一次接入的外部合作方后端工程师,懂 HTTP 不懂我们的领域模型) - 现有材料:{{已有材料}}(示例:一份 200 行未加注释的 Python 模块、3 条 Slack 讨论记录、零散的口头约定) - 硬约束:{{约束条件}}(示例:本周五前必须发布;只能写 1 页;公司要求全英文;必须通过内部文档 lint 检查) - 他卡住的地方:{{具体卡点}}(示例:不知道先写哪个部分,怕写错被 review 打回) 【输出格式】严格按以下结构,总长不超过 900 字: 1. 问题定性(≤80 字):判断他的卡点主要属于信息缺口 / 结构缺口 / 读者错配中的哪一类,并说明依据。 2. 推荐文档骨架:用无序列表给出 4–7 个一级小节标题,每节后用一句话注明「这节回答读者的什么问题」。 3. 写作顺序:给出先写哪节、后写哪节的排序,并说明为什么这样排(依据:先写信息最确定的,还是先写读者最先看的)。 4. 三个必须写进去的具体内容:每条一行,写成「必须包含 X,因为读者会用它做 Y」。 5. 决策依据:列出 2–3 条取舍原则(如「宁可少写也不要写未验证的行为」),每条附一句适用条件。 6. 注意事项与常见坑:3–5 条,每条用「现象 → 后果 → 规避动作」的句式。 7. 若信息不足:如果 {{已有材料}} 或 {{约束条件}} 为空,先列出你需要他补充的最多 3 个问题,然后停止,不要臆测他的项目细节。 硬性要求:所有建议必须能对应到上面给出的处境变量;不得出现「建议参考官方文档」这类无法执行的表述;不得编造他的代码或项目事实。
还有 3 个必填变量未填,补齐后才能复制
还有 3 个变量没填。照样能跑——缺失的部分会按常见情况假设,并标注在成品末尾。
AI 评审依据
这条提示词还没有评审记录
- 目标模型
- ChatGPT、Claude
- 框架
- CRISPE
- 语言
- zh-CN
- 作者
- 站方
标签
- adr
- readme
- 技术文档
- 决策依据
- 写作方案
同类提示词
代码注释风格争议的裁决建议
93AI 质量分当团队对某段代码该不该加注释、注释写到什么粒度产生分歧时,由资深维护者视角给出裁决结论、理由与可执行的注释规范片段。
问答咨询进阶COSTAR免费
AI 生成站方 · 复制 0 次