项目文档写作
为新功能或发布从零写开发者文档,基于产品意图和真实代码而不是照标题猜。
功能与用途
面向「内容还不存在」的场景:为新功能、产品发布或一张需求单从头撰写开发者文档,而不是修已有的文档 bug 或重构旧页面。四条输入缺一不可:产品意图(有需求管理工具就读它)、真实代码、文档风格指南、以及已有的相近页面作为参照。三条核心规则很硬:不要只看着标题就动笔,先收集齐输入,收集得太薄写出来的稿子会对功能实际怎么工作描述错误;把「代码证明的现状」「产品意图」「你的推断」三者分开标注,凡是猜的地方必须显式标出来而不是当成事实写;风格文件只用来定语气、术语和格式,绝不能拿它当内容准确性的依据。
适用场景
- 新功能上线开发者指南编写:基于真实代码分支与需求记录,理清实际功能逻辑与预期定位,为新上线特性编写端到端使用教程。
- 跨服务复杂功能的使用指引整理:核对前端、后端与命令行工具的代码实现,严格区分代码事实与推断,撰写严谨的系统操作步骤。
- 常见报错与故障排查文档编写:依据系统错误处理逻辑和真实异常分支,撰写具备明确上下文与可执行解决方案的排错专栏。
适用人群
- 技术文档工程师
- 产品经理
- 独立开发者
使用步骤
- 收集产品意图、代码、风格指南与参照页面四项输入
- 区分已确认行为、产品意图与推断并分别标注
- 按风格指南撰写初稿并标明沿用的既有页面先例
- 交付前检查事实口径是否都有依据
开始使用
将需求和 Skill 名称发送给已连接 SkillPX MCP 的 AI 助手,核对适用工具和安装要求。
技术信息
- 分类
- 办公
- 适用工具
- Codex、Claude Code、OpenClaw、Hermes、国内 Agent
- 使用难度
- 进阶
- 版本
- master
- 最近更新
- 2026-09-17
- 文件数
- 3
- 安装包大小
- 自动生成 ZIP
- 安全检查
- 基础检查通过
>-
使用前准备
- 可读的产品源码
- 产品意图或需求文档
- 项目风格指南与相近页面
依赖与权限
- 读取用户主动提供的内容