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. 03REST 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/ から読み込まれます。

クイックリファレンス

カテゴリルール重要度使用する場面
README1高プロジェクトの開始、コントリビューターのオンボーディング
ADR1高アーキテクチャ上の決定事項の記録
API ドキュメント1高OpenAPI 3.1 を使用した REST API のドキュメント作成
変更履歴1中リリース履歴の管理
文章スタイル1中あらゆる技術文書の作成

合計：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 に基づく「追加」「変更」「非推奨」「削除」「修正」「セキュリティ」の各セクション

文章スタイル

明確で読みやすいドキュメントを作成するための技術文書の規約です。

  • docs-writing-style -- 能動態、現在形、簡潔な文、API ドキュメントのチェックリスト

関連スキル

  • ork:api-design -- API 設計パターン（OpenAPI ドキュメントを補完）
  • ork:architecture-decision-record -- ADR のワークフローとライフサイクル
  • ork:release-management -- 変更履歴の更新を含むリリースプロセス

バージョン： 1.0.0（2026年3月）

コメント

Markdown 対応