SuperAPI AI 工具集

documentation-patterns

写作与研究

查看项目

更新于 10-16 03:47

技能介绍

用途:当主要问题是文档形态与一致性(而非仅写作质量)时使用,用于创建新的 API、功能或配置指南,统一跨仓库的 Markdown 章节,撰写迁移或运行手册文档,以及为文档请求挑选合适模板。

主要能力:提供 API 文档(端点、认证、请求与响应结构、错误)、功能文档(目的、UX、依赖、发布、支持)、配置文档(环境变量、默认值、示例、故障模式)、迁移文档(行为变更、升级路径、验证)等模板与结构模式,并给出模式选择指引。

使用方式:按“症状→动作”触发;先用 documentation-authoring 收集上下文并起草内容,再用本技能确定结构与模板,最后用 documentation-quality 复核。代理提示模板:使用 documentation-patterns 技能为某文档类型选择并应用最佳结构,返回推荐的章节大纲及每节存在理由的简短说明。跨客户端:GitHub Copilot 放于可见技能路径或项目说明中;Claude Code 放本地技能目录或兼容插件源;Codex 安装或同步到 $CODEX_HOME/skills/documentation-patterns 并在重大变更后重启。无需 MCP;回退提示为在不使用 MCP 的情况下依据本地说明与工具直接验证。

验证协议:输出需识别受众、目的、事实来源与时效要求;引用共享文档栈指导;核查链接、命令、示例、截图及版本敏感声明,未验证需显式标注。

限制与反模式:避免为作者而非读者写作、缺少具体示例或命令、链接截图版本漂移;不得声称使用了当前宿主未暴露的 MCP 操作;共享栈要求先确定负责人、受众、规范文件与时效,选择最小可复用模式,发布前核验,并说明未解决的缺口与后续评审触发点。