mcpField
D
documentation-patterns

documentation-patterns

github.com/yonatangross开发299144 次安装今天更新
代码仓库

关于 documentation-patterns

documentation-patterns 面向技术写作者和开发者，提供一致的文档结构与规则。内容涵盖 README、ADR、OpenAPI 3.1 API 文档、更新日志和技术写作风格，并可按需加载。

主要功能

  1. 01README 结构模板
  2. 02架构决策记录格式
  3. 03OpenAPI 3.1 文档模式
  4. 04Keep a Changelog 格式
  5. 05技术写作规范

适用场景

  1. 01编写项目 README
  2. 02记录架构决策
  3. 03编写 REST API 文档
  4. 04维护版本更新记录

安装

复制下面的命令，在终端中运行。

$npx skills add https://github.com/yonatangross/orchestkit --skill documentation-patterns

安装后在 Claude Code 中输入/documentation-patterns确认已加载。

包含的文件

除 SKILL.md 外，安装时一起下载的参考资料和脚本。

test-cases.json
rules/
_sections.md
_template.md
docs-api-openapi.md
docs-readme-structure.md
docs-changelog-format.md
docs-adr-template.md
docs-writing-style.md

详细介绍

文档模式

面向技术文档的模板和规范化结构——README、架构决策记录、OpenAPI 规范、变更日志和写作风格。每个类别都有单独的规则文件，按需从 rules/ 加载。

快速参考

类别规则影响适用场景
README1HIGH启动项目、引导贡献者
ADR1HIGH记录架构决策
API 文档1HIGH使用 OpenAPI 3.1 编写 REST API 文档
变更日志1MEDIUM维护版本历史
写作风格1MEDIUM任何技术写作任务

总计：5 个类别中的 5 条规则

快速入门

## README Skeleton
# Project Name
Brief description -> Quick Start -> Installation -> Usage -> API -> Config -> Contributing -> License

## ADR Format
# ADR-001: Title
Status -> Context -> Decision -> Consequences (positive/negative) -> References

## OpenAPI Minimum
openapi: 3.1.0 with info, paths, components/schemas, error responses

## Changelog Entry
## [1.2.0] - 2026-03-05
### Added / Changed / Deprecated / Removed / Fixed / Security

## Writing Rule of Thumb
Active voice, present tense, second person, one idea per sentence

README

适用于开源和内部项目的完整 README 模板，包含所有必要章节。

  • docs-readme-structure -- 项目名称、快速入门、安装、用法、API 参考、配置、贡献、许可证

架构决策记录

用于记录架构决策及其背景和后果的结构化格式。

  • docs-adr-template -- 状态、背景、决策、后果（正面／负面）、参考资料

API 文档

用于编写一致且机器可读的 API 文档的 OpenAPI 3.1 规范模式。

  • docs-api-openapi -- 路径结构、操作定义、架构组件、错误响应（RFC 9457）

变更日志

使用 Keep a Changelog 格式编写经过整理、便于阅读的版本历史。

  • docs-changelog-format -- 使用 semver 划分 Added、Changed、Deprecated、Removed、Fixed、Security 章节

写作风格

有助于撰写清晰、便于浏览的文档的技术写作规范。

  • docs-writing-style -- 主动语态、现在时、简洁句子、API 文档检查清单

相关技能

  • ork:api-design -- API 设计模式（补充 OpenAPI 文档）
  • ork:architecture-decision-record -- ADR 工作流和生命周期
  • ork:release-management -- 包含变更日志更新的发布流程

版本： 1.0.0（2026 年 3 月）

评论

支持 Markdown