Token导航 LogoToken导航

Agent Skill · 待分类

documentation-patterns（文档模式）

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

documentation-patterns 是待分类类 Agent Skill，可用宿主为 Codex、Claude、Cursor、Gemini CLI，通过GitHub 仓库获取，权限为接触敏感数据；许可证信息还不明确，第三方扫描已通过，按安装量在待分类类的 11,209 个 Skill 里排第 10,789。

总安装 190周安装 8GitHub Stars 3下载 67核验 2026-05-01
待分类接触敏感数据GitHub 仓库未标认证来源可访问许可证需确认审计通过CodexClaudeCursorGemini CLI

安装说明

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

安装方式

通过对话安装

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

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

命令行安装

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

skills.shnpx skills
npx skills add https://github.com/practicalswan/agent-skills --skill documentation-patterns

这个 Skill 是做什么的

这个 Skill 的分类还没最终确定，用法以来源仓库的说明为准。

解决文档形态与一致性难题，而非单纯提升文字质量本身的问题。针对 API 说明、功能介绍、配置指南等不同场景匹配相应模板。适用于新建接口规范、跨仓库 Markdown 章节标准化等具体需求。重点在于选择合适的内容骨架，让后续填充工作更加高效有序。

documentation-patterns 属于待分类类 Skill，可作为该场景下的辅助能力补充。

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

上手步骤

4 步
  1. 1

    确认自己的宿主工具

    公开资料标注支持 Codex、Claude、Cursor、Gemini CLI；先确认自己用的是其中之一，再按对应工具的 Skills 目录放置。

  2. 2

    拿到安装命令

    可以直接复制的命令是 npx skills add https://github.com/practicalswan/agent-skills --skill documentati…；命令里的占位符换成自己的路径或密钥再执行。

  3. 3

    安装后重启宿主

    命令执行完要完全退出宿主工具再打开，让新装的 Skill 被重新扫描到，否则列表里可能看不到。

  4. 4

    按最小权限试用

    它需要接触敏感数据，先在测试目录或测试账号里跑，确认没问题再放到正式项目。

常见问题

6 条

documentation-patterns 怎么安装？

在终端执行 npx skills add https://github.com/practicalswan/agent-skills --skill documentation-pattern…。装完完全退出宿主工具再打开，让它重新扫描本地 Skill。

documentation-patterns 支持哪些 AI 工具？

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

documentation-patterns 需要什么权限？

权限级别是接触敏感数据。该 Skill 可能接触密钥、Token、环境变量或敏感配置，应进入高风险复核队列，默认不自动发布。

documentation-patterns 是免费的吗？

公开资料没有标注明确许可证，收费和商用限制都无法确认。正式使用前请到来源仓库核对授权说明。

documentation-patterns 用的人多吗？

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

documentation-patterns 安全吗？

第三方扫描结果为通过，但这只覆盖已知的静态检查项，不能替代自己读一遍源码和安装命令。

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

值得选的地方

  • 同时适配 4 种工具，换客户端不用重新找替代品。
  • 第三方扫描已通过，常见的高风险行为没有命中。

先想清楚的地方

  • 需要接触敏感数据，装到常用环境前要先评估影响面。
  • 许可证没有明确标注，能不能商用、能不能再分发都不确定。
  • 第三方目录整理，版本更新和行为细节以来源仓库为准。

适不适合你

更适合

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

不太适合

  • 环境里有大量密钥、凭证，不方便给第三方 Skill 读取的人。
  • 需要明确授权才能用到公司项目里的场景。
  • 需要厂商级技术支持和 SLA 的生产系统。

待分类类 Skill 对比

6 个同类
Skill总安装GitHub 星权限许可证扫描
infsh-cli

infsh CLI · Codex、Claude

4,374,576382权限未标注未明确未收录
ai-video-generation

AI 视频生成 · Codex、Claude

4,313,376382调用外部服务未明确有提醒
lark-openapi-explorer

云雀 OpenAPI 浏览器 · Codex、Claude

2,064,1209,011需要联网未明确有提醒
lark-workflow-standup-report

Lark 工作流程站立报告 · Codex、Claude

2,041,6328,978需要联网未明确通过
use-my-browser

使用我的浏览器 · Codex、Claude

1,848,49140操作浏览器未明确未通过
documentation-patterns

文档模式 · 本页

1903接触敏感数据未明确通过

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

SKILL.md 原文

Documentation Patterns

Use this skill when the main problem is document shape and consistency rather than writing quality alone.

Activation Conditions

  • Creating a new API, feature, or config guide
  • Standardizing Markdown sections across repositories
  • Writing migration or runbook documents
  • Picking the right template for a doc request

Pattern Selection

  • API docs: endpoints, auth, request and response schema, errors
  • Feature docs: purpose, UX, dependencies, rollout, support
  • Config docs: env vars, defaults, examples, failure modes
  • Migration docs: changed behavior, upgrade path, verification

References & Resources

Documentation

Scripts

Related Skills

SkillRelationship
documentation-authoringUse patterns when creating new documents
documentation-qualityQuality standards that patterns should follow
breaking-changes-managementTemplates for migration guides and changelogs

平台分布

Codex

36.36%
按下载量换算24

Claude

28.17%
按下载量换算19

Cursor

16.4%
按下载量换算11

Gemini CLI

9.59%
按下载量换算6

安全审计

Gen Agent Trust Hub

通过

Socket

通过

Snyk

通过

权限和风险

接触敏感数据

该 Skill 可能接触密钥、Token、环境变量或敏感配置，应进入高风险复核队列，默认不自动发布。

安装前确认

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

继续浏览同类 Skills

更多待分类 Skills（11,209）返回 Skills 目录

上一个 Skill

documentation（文档）

iulspop/aidd-skills

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

下一个 Skill

documentation-patterns（文档模式）

yonatangross/orchestkit

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