返回技能库

内容写作

让 AI 写出真正可维护的项目文档

从读者任务出发，生成能验证、能更新的使用文档。

进阶30 分钟更新于 2026-09-28

OUTCOME

先看最终成果

一份结构明确、示例可运行、版本边界清晰，并且方便后续更新的项目文档。

STEP BY STEP

跟着步骤完成

01
定义读者任务
列出读者来到文档后最想完成的三件事，并明确其知识水平和运行环境。
02
建立信息架构
按快速开始、核心概念、常见任务、配置、故障排查和参考资料组织，而非照代码目录抄写。
03
验证所有示例
在干净环境运行安装、命令和代码示例，记录依赖版本与预期输出。
04
补足失败路径
加入常见错误、诊断办法和恢复步骤，让文档不仅描述成功情况。
05
设置维护线索
注明适用版本、更新时间、内容责任人和与代码变更相关的检查点。

PROMPT

可直接使用的提示词

请为{{项目}}撰写面向{{目标读者}}的文档。读者需要完成{{核心任务}}。先给出信息架构，再编写快速开始、核心概念、常见任务、故障排查和版本说明。所有命令必须基于我提供的项目内容，不得虚构接口；无法验证的示例标记“待验证”。项目资料：{{资料}}

把双大括号中的内容替换为你的真实信息。先补足上下文，再追求表达效果。

QUALITY CHECK

交付前检查

五分钟内能完成第一个任务
命令和示例已实际验证
说明了依赖与版本范围
包含常见失败及恢复办法
文档结构围绕读者任务

SOURCE

来源与改编说明

原始技能Documentation Writer

仓库: github/awesome-copilot
作者: GitHub 社区贡献者
许可证: MIT License
参考日期: 2026-09-28

本站结合原技能的文档工作流，重新编写为面向中文项目团队的实践教程。