SuperAPI AI 工具集

documentation-structure

写作与研究

查看项目

更新于 10-15 17:06

技能介绍

用途

documentation-structure 是一个文档架构规范技能,用于在创建、更新或审查 README.md、CONTRIBUTING.md 或 docs/ 文件时提供结构指导。它定义了文档在仓库中如何组织与维护。

核心原则

  • 关注点分离:README 作为落地页,docs/ 作为参考资料,CONTRIBUTING 作为开发工作流。
  • 单一事实来源:只定义一次,到处链接,绝不重复内容。
  • 中心辐射:docs/README.md 是中央导航中心。
  • 厂商隔离:每个 AI 平台在 docs/ 下拥有自己的目录。

文档职责划分

关键规则:用户文档只能包含全自动安装方式,所有手动设置都属于开发者文档。

用户文档(README.md、docs/*/overview.md):安装必须复制粘贴即可完成;单条命令或纯 UI 步骤;需要手动替代方案时链接到开发文档。

开发者文档(CONTRIBUTING.md、docs//-development.md):所有手动设置工作流;本地测试流程;配置文件编辑;环境设置。

README.md(落地页)

目的:第一印象,让用户快速上手。

必须包含:一行描述;快速开始(4 步:选择 → 安装 → 认证 → 试用);能力表格(用户能做什么);指向 docs/ 的链接。

不应包含:完整 API 参考(→ docs/mcp/);开发工作流(→ CONTRIBUTING.md);详细架构(→ docs/)。

docs/(参考资料)

目的:面向用户和开发者的完整参考。

结构示例:

docs/ ├── README.md # 导航中心 ├── troubleshooting.md # 跨平台问题 ├── getting-started/ # 入口 │ ├── mcp-setup.md # 通用 MCP 配置 │ └── enterprise.md # 管理员要求 ├── claude-code/ # 厂商:Claude Code ├── kiro/ # 厂商:Kiro ├── gemini-cli/ # 厂商:Gemini CLI └── mcp/ # 协议参考 ├── tools-reference.md └── tutorials.md

CONTRIBUTING.md(开发工作流)

目的:如何修改本仓库。

必须包含:克隆与本地开发设置;如何在本地测试更改(--plugin-dir 等);校验清单;PR 流程。

不应包含:完整插件/功能架构(→ docs/);面向用户的教程(→ docs/)。

厂商文档标准

docs/ 中每个厂商目录遵循以下模式。必需文件:overview.md(这个集成是什么、为何使用、安装)、*-development.md(如何构建新的插件/功能/扩展)、单个组件文档(每个插件/功能一个文件)。

overview.md 的标准章节:What are [Plugins/Powers/Extensions]?、Why Use [Plugins/Powers] vs Direct MCP?、Available [Plugins/Powers]、Installation、Authentication、Related。

厂商专属元数据:Claude Code 使用 plugin.json,位置 .claude-plugin/plugin.json;Kiro 使用 POWER.md frontmatter,位置 POWER.md;Gemini CLI 使用 JSON extension,位置 gemini-extension.json。

交叉引用模式

docs/ 内部使用相对路径,如 text;从 README 到 docs/ 使用 docs/ 前缀,如 text;外部链接使用完整 URL,如 text。

必需的相关章节:每个文档文件应以 Related 章节结尾,示例:

Related

  • Overview - Introduction to this integration
  • Tools Reference - MCP tool documentation

互链:如果文档 A 链接到文档 B,文档 B 应在 Related 章节中链接回文档 A。

校验指南

提交文档更改前进行以下检查。

内容检查:无重复内容(改为链接);正确的文档拥有该内容(README vs docs/ vs CONTRIBUTING);按厂商标准包含所有章节。

链接检查:所有内部链接可解析;Related 章节有互链;外部链接使用 HTTPS。

格式检查:代码块指定语言;表格格式一致;折叠块标签匹配。

参见

references/patterns.md - 格式模式(表格、折叠块、代码块)。

限制

技能资料未提供具体支持的平台范围、安装方式、版本要求或收费信息,这些事实暂未提供。