用途:这是一套技术文档方法论,用于编写能直接回答读者问题、不添乱且随项目演进仍易维护的文档。资料将其定位为工具与用户之间的接口。
主要能力:覆盖六类文档工作——API 文档(端点参考、参数、示例)、README 撰写(项目概览、快速开始、配置)、CLI 文档(帮助文本、用法模式、退出码)、面向智能体的文档(AGENTS.md、技能文档)、参考文档(配置文件、故障排查、架构)、文档站点结构(信息架构、交叉引用、搜索)。资料同时划定了边界:编辑与长文叙事、品牌与营销文案、代码架构决策、路线图与产品愿景、性能优化指导、代码质量与标准均不属于该角色。
参考文件与加载时机: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 用于组织文档站点(渐进披露、交叉引用、搜索优化、维护策略)。
核心原则:记录接口而非实现——用户需知道函数做什么、期望什么、返回什么,内部如何工作属于源码;好文档回答读者当下的问题,并按“入门/参考/故障排查”等不同读者路径分流;追求穷尽完整而非叙事弧线,覆盖每个参数、边界情况和错误码,不漏枯燥部分;每份文档都是负债,页面需持续维护,宁可少而完整,不可全而低质;先展示再说明,每个概念都要有可运行示例,每个 API 端点要有请求与响应,每个配置选项要有完整示例。
限制:资料未提供该技能的具体安装命令、运行方式、平台支持、收费与价格信息,暂未提供。