Token导航 LogoToken导航TokenDH.com
待分类敏感数据github未标认证来源可访问许可证需确认审计通过

documentation-patterns文档模式

Agent Skill

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

总安装

190

周安装

8

GitHub Stars

3

下载量

67
CodexClaudeCursorGemini CLI

安装说明

本站只整理中文说明和来源信息,不托管安装包,也不代用户安装。

GitHub

来源数

2

许可证

unknown

最后核验

2026-05-01

来源状态

来源可访问

安装方式

通过对话安装

复制提示词发给支持本地命令或 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

简介

解决文档形态与一致性难题,而非单纯提升文字质量本身的问题。

  • 针对 API 说明、功能介绍、配置指南等不同场景匹配相应模板。
  • 适用于新建接口规范、跨仓库 Markdown 章节标准化等具体需求。
  • 重点在于选择合适的内容骨架,让后续填充工作更加高效有序。
  • documentation-patterns 属于待分类类 Skill,可作为该场景下的辅助能力补充。

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

适合场景

01

用户想查找某类 Agent Skill 时

02

需要根据任务场景推荐可安装能力包时

03

需要对比不同来源的安装命令和来源信息时

能力概览

能力 1

按任务关键词查找相关 Skills

能力 2

展示可复制的安装命令

能力 3

保留来源站点、仓库和原始说明,方便继续核验

能力 4

展示第三方安全扫描或审计结果

安装后应在对应宿主中按原始 README 的触发条件使用;具体调用方式请以来源页面和 README 为准。

平台分布

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