Agent Skill · 研究检索

documentation-builder（文档生成器）

用于辅助文档、README、Markdown、说明文和内容稿件的整理与改写。它适合让 Agent 提炼结构、补齐章节、统一术语、检查链接或把零散材料整理成可读文档。使用时应保留项目已有事实、命令和路径，不要把未确认的信息写成确定结论；涉及对外文案时，还需要控制语气，避免过度营销或夸大能力。

documentation-builder 是研究检索类 Agent Skill，可用宿主为 Codex、Claude、Cursor、Gemini CLI，通过GitHub 仓库获取，权限为需要联网；许可证为 MIT，暂无第三方扫描结果，按安装量在研究检索类的 73,675 个 Skill 里排第 59,803。

总安装 376周安装 16GitHub Stars 公开资料未说明下载 132核验 2026-05-01

研究检索需要联网 GitHub 仓库未标认证来源可访问许可证明确审计未展示Codex Claude Cursor Gemini CLI

安装说明

本站只整理中文说明，不托管安装包，也不代用户安装。

GitHub

许可证: MIT

安装方式

通过对话安装

复制提示词发给支持本地命令或 Skills 的 AI 助手，先确认命令和权限，再让它执行。

请帮我安装这个 Agent Skill：documentation-builder（文档生成器）
来源仓库：https://github.com/teachingai/agent-skills
仓库路径：skills/documentation-builder
安装命令：
npx skills add teachingai/agent-skills --skill "documentation-builder"
安装前请先检查当前环境是否支持对应 CLI，并向我确认将要执行的命令、安装目录、联网范围和文件读写权限；确认后再执行。

命令行安装

复制命令到本机终端执行。该命令会通过 npx skills 从第三方来源获取 Skill；本站只展示命令，不托管安装包，也不自动执行。

AgentSkills.tonpx skills

npx skills add teachingai/agent-skills --skill "documentation-builder"

这个 Skill 是做什么的

研究检索类 Skill 主要解决「找资料、核对事实、把来源整理清楚」的问题，通常会让助手先检索再总结。

documentation-builder 用于辅助文档、README、Markdown 和内容稿件的整理与改写。适合让 Agent 提炼结构、补齐章节、统一术语或检查链接。

通过 GitHub 安装，使用 npx skills add teachingai/agent-skills --skill "documentation-builder" 命令添加。使用时应保留项目已有事实和路径，不要把未确认的信息写成确定结论；涉及对外文案时需控制语气。

可结合来源仓库和原始 README 继续核验具体用法。

来源仓库内路径：skills/documentation-builder

上手步骤

4 步

1
确认自己的宿主工具
公开资料标注支持 Codex、Claude、Cursor、Gemini CLI；先确认自己用的是其中之一，再按对应工具的 Skills 目录放置。
2
拿到安装命令
可以直接复制的命令是 npx skills add teachingai/agent-skills --skill "documentation-builder"；命令里的占位符换成自己的路径或密钥再执行。
3
安装后重启宿主
命令执行完要完全退出宿主工具再打开，让新装的 Skill 被重新扫描到，否则列表里可能看不到。
4
按最小权限试用
它需要需要联网，先在测试目录或测试账号里跑，确认没问题再放到正式项目。

常见问题

6 条

documentation-builder 怎么安装？

在终端执行 npx skills add teachingai/agent-skills --skill "documentation-builder"。装完完全退出宿主工具再打开，让它重新扫描本地 Skill。

documentation-builder 支持哪些 AI 工具？

公开资料标注支持 Codex、Claude、Cursor、Gemini CLI。其他工具只要能读取本地 Skill 目录，一般也能手动放进去，但要自己确认触发方式是否一致。

documentation-builder 需要什么权限？

权限级别是需要联网。该 Skill 可能需要联网访问来源站点、仓库或外部 API；具体网络访问范围需要结合源码和 README 复核。

documentation-builder 是免费的吗？

来源标注的许可证是 MIT。本站不代收任何费用，也不托管安装包；能否商用、要不要署名，以许可证原文为准。

documentation-builder 用的人多吗？

公开数据是累计安装 376 次，近一周安装 16 次，下载 132 次。这些数字来自第三方目录统计，只能当作热度参考，不代表质量或安全性。

documentation-builder 安全吗？

没有查到第三方扫描结果，安全性无法从公开资料判断，安装前请自行审查源码、依赖和命令行为。

值得选的地方和要先想清楚的地方

值得选的地方

同时适配 4 种工具，换客户端不用重新找替代品。
许可证明确为 MIT，商用和分发边界好判断。

先想清楚的地方

没有第三方扫描结果，安全性只能靠自己读源码判断。
第三方目录整理，版本更新和行为细节以来源仓库为准。

适不适合你

更适合

已经在用 Codex，想直接扩展它能力的人。
需要处理研究检索类任务、又不想每次都手写提示词的人。

不太适合

要求有安全扫描结论才肯安装的团队。
需要厂商级技术支持和 SLA 的生产系统。

研究检索类 Skill 对比

6 个同类

Skill	总安装	GitHub 星	权限	许可证	扫描
find-skills 寻找技能 · Codex、Claude	31,199,813	16,486	操作浏览器	MIT	有提醒
self-improving-agent 自我改进 Agent · OpenClaw	16,464,002	3,396	接触敏感数据	MIT-0	通过
soultrace 灵魂追踪 · Codex、Claude	7,588,944	12	需要联网	未明确	有提醒
self-improving 自我完善 · OpenClaw	6,829,284	1,046	需要联网	MIT-0	通过
microsoft-foundry 微软代工厂 · Codex、Claude	6,614,144	764	调用外部服务	未明确	有提醒
documentation-builder 文档生成器 · 本页	376	—	需要联网	MIT	未收录

按安装量取同分类前几名；数字来自第三方目录统计，只作热度参考，不代表质量结论。

SKILL.md 原文

文档构建技能

概述

本技能帮助您生成各种技术文档，包括 API 文档、用户手册、开发指南等。

关键词: 文档编写、API 文档、用户手册、开发指南、技术文档、README

核心功能

1. API 文档生成

生成 RESTful API 文档
描述 API 端点、参数和响应
提供请求和响应示例
创建交互式 API 文档（如 Swagger/OpenAPI）

2. 用户手册编写

编写用户使用指南
创建快速入门教程
提供常见问题解答（FAQ）
设计操作步骤和截图

3. 开发指南创建

编写开发环境搭建指南
创建代码贡献指南
设计架构和设计文档
提供开发最佳实践

4. README 和项目文档

生成项目 README
创建安装和使用说明
编写变更日志（CHANGELOG）
设计项目结构说明

使用指南

文档编写原则

清晰性: 文档应清晰易懂，避免歧义
完整性: 覆盖所有重要功能和场景
准确性: 确保文档与代码一致
实用性: 提供实际可用的示例
可维护性: 文档应易于更新和维护

文档结构

概述: 项目或功能的概述
快速开始: 快速上手指南
详细说明: 详细的功能说明
API 参考: API 接口文档（如适用）
示例: 使用示例和代码示例
常见问题: FAQ 和故障排除

文档格式

Markdown（.md）
reStructuredText（.rst）
HTML
PDF（如需要）

输出格式

文档应包含：

文档文件: 完整的文档内容
目录结构: 清晰的章节和目录
代码示例: 实际可运行的代码示例
图表和截图: 可视化说明（如需要）
链接和引用: 相关资源的链接

最佳实践

使用清晰的标题和章节结构
提供实际可用的代码示例
保持文档与代码同步更新
使用图表和截图辅助说明
编写易于搜索的文档
考虑不同水平的读者
定期审查和更新文档

平台分布

Claude Code

28.1%

按下载量换算37

OpenCode

23.4%

按下载量换算31

Antigravity

17.11%

按下载量换算23

Codex

13.14%

按下载量换算17

windsurf

7.64%

按下载量换算10

Gemini CLI

3.5%

按下载量换算5

安全审计

暂无安全审计结果可展示。

权限和风险

需要联网

该 Skill 可能需要联网访问来源站点、仓库或外部 API；具体网络访问范围需要结合源码和 README 复核。

安装前确认

本站仅展示第三方公开信息，不托管安装包，不提供自动安装或运行环境。安装前应自行审查源码、依赖和命令行为。目前只有一个公开来源，建议同时核对源仓库。

继续浏览同类 Skills

更多研究检索 Skills（73,675）返回 Skills 目录

上一个 Skill

documentation-authoring（文档创作）

practicalswan/agent-skills

下一个 Skill

documentation-engineer（文档工程师）

404kidwiz/claude-supercode-skills