用途
该技能是一套技术文档方法论,用于创建和评审技术文档,包括 README、面向智能体的说明文档、API 参考文档和 CLI 帮助文本。其定位是充当工具与用户之间的接口,目标是写出能回答读者问题、不阻碍读者、并随项目演进保持可维护的文档。
职责边界
技能明确划分了「你负责」与「你不负责」的范围:
- 负责:API 文档(端点参考、参数、示例)、README 撰写(项目概览、快速开始、配置)、CLI 文档(帮助文本、用法模式、退出码)、面向智能体的文档(AGENTS.md、技能文档)、参考文档(配置文件、故障排查、架构)、文档站点结构(信息架构、交叉引用、搜索)。
- 不负责:编辑与长篇叙事内容(属编辑职能)、品牌信息与营销文案(属品牌设计)、代码架构决策(属软件架构分析)、项目路线图与产品愿景(属产品经理)、性能优化指导(属系统化调试/SRE)、代码质量与标准(属 QA 方法论/QA 工程师)。
参考文件
技能包含四份参考文件,按需加载:
- references/readme-patterns.md:撰写或重构 README 时使用,涵盖每个 README 必需的章节、快速开始模式、安装变体、配置文档。
- references/api-documentation-cli-help.md:记录 API(端点结构、参数约定、示例设计、认证模式、OpenAPI 注解)以及设计 CLI 帮助文本(用法行、标志、退出码、子命令层级、man 手册页)。
- references/agent-facing-docs.md:撰写 AGENTS.md 和技能文档,涵盖触发模式、加载顺序、输出契约、交叉引用。
- references/information-architecture.md:构建文档站点,涵盖渐进式披露、交叉引用、搜索优化、维护策略。
相关技能
documents:从文档内容生成办公格式交付物(PDF、Word、Excel、PowerPoint);文档站点与标记约定仍归本技能。
核心原则
- 记录接口而非实现——用户需要知道函数做什么、期望什么、返回什么;内部如何工作属于源代码。
- 好文档回答读者的问题——不同读者带着不同问题(入门、参考、故障排查),应组织文档让每类读者快速找到答案。
- 穷尽式完整优先于叙事弧线——技术文档不是文章,读者会跳到需要的部分,应覆盖每个参数、每个边界情况、每个错误码,不要跳过枯燥的部分。
- 每份文档都是负担——每页都需维护,宁可少写但更完整,也不要什么都写但质量更低;维护成本与表面积成正比。
- 展示而非仅讲述——每个概念需要可运行示例,每个 API 端点需要请求与响应,每个配置选项需要完整示例而非仅描述。
可移植性
该技能有意保持宿主中立。使用智能体的常规机制加载此处列出的参考文件、模板和脚本,不要假定特定的 profile 系统、任务编排器、记忆服务或响应交接格式。
适用场景与限制
适用于需要编写或评审 README、API 参考、CLI 帮助、面向智能体文档及文档站点结构的场景。技能本身未提供具体收费、价格、平台或效果信息;其官方文本为空,具体模板与脚本内容暂未提供。