mcpField
D
documentation-structure

documentation-structure

github.com/miroapp開発164222 回インストール6 週間前に更新
リポジトリ

documentation-structure について

リポジトリのドキュメント整理と保守のためのスキルです。ユーザー向け、開発者向け、プラットフォーム連携の文書の役割を分け、ナビゲーションや相互リンク、確認項目を定めます。

主な機能

  1. 01README、docs、貢献ガイドの役割定義
  2. 02docs/README.mdをナビゲーションハブとして使用
  3. 03ユーザー向けと開発者向け文書の分離
  4. 04ベンダーディレクトリとファイル構成の規定
  5. 05内容、リンク、形式のチェック項目

活用シーン

  1. 01新しい連携向けに文書構成を統一
  2. 02インストール手順の掲載先を判断
  3. 03必須セクションと文書リンクを確認
  4. 04重複を防ぎ相互参照を維持

インストール

コマンドをコピーしてターミナルで実行します。

$npx skills add https://github.com/miroapp/miro-ai --skill documentation-structure

インストール後、Claude Code で/documentation-structureを入力して読み込まれたか確認します。

同梱ファイルreferences/patterns.md

詳細

ドキュメント構成

このスキルでは、このリポジトリにおけるドキュメントの構成と保守方法を定義します。

基本原則

原則説明
関心の分離README（ランディングページ）、docs/（リファレンス）、CONTRIBUTING（開発ワークフロー）
単一の信頼できる情報源一度定義し、あらゆる場所からリンクします。コンテンツを重複させないでください。
ハブとスポークdocs/README.md は、ナビゲーションの中心となるハブです
ベンダーの分離各 AI プラットフォームには、docs/ 内に専用ディレクトリを用意します

ドキュメントの役割

ユーザー向けコンテンツと開発者向けコンテンツの分離

重要なルール： ユーザー向けドキュメントには、完全に自動化されたインストール方法のみを記載してください。手動セットアップはすべて、開発者向けドキュメントに記載します。

コンテンツの種類ユーザー向けドキュメント開発者向けドキュメント
マーケットプレイスからのインストール✓✓
GitHub からのワンコマンドインストール✓✓
git clone✗✓
--plugin-dir✗✓
extensions リンク✗✓
JSON 設定の編集✗✓
ローカルパスのセットアップ✗✓
mcp_settings.json✗✓
ユーザー向けドキュメント（README.md、docs/*/overview.md）
  • インストールはコピー＆ペーストだけで簡単にできるようにします
  • 単一のコマンド、または UI のみで完了する手順にします
  • 手動での代替方法については、開発者向けドキュメントにリンクします
開発者向けドキュメント（CONTRIBUTING.md、docs//-development.md）
  • 手動セットアップのワークフローをすべて記載します
  • ローカルテストの手順
  • 設定ファイルの編集
  • 環境のセットアップ
README.md（ランディングページ）

目的： 第一印象を伝え、ユーザーがすぐに使い始められるようにします。

必ず含める内容：

  • 1 行の説明
  • クイックスタート（4 ステップ：選択 → インストール → 認証 → 試用）
  • 機能の表（ユーザーができること）
  • 詳細を確認できる docs/ へのリンク

含めてはいけない内容：

  • API リファレンス全体（→ docs/mcp/）
  • 開発ワークフロー（→ CONTRIBUTING.md）
  • 詳細なアーキテクチャ（→ docs/）
docs/（リファレンスドキュメント）

目的： ユーザーと開発者向けの完全なリファレンスです。

構成：

docs/
├── README.md              # Navigation hub
├── troubleshooting.md     # Cross-platform issues
├── getting-started/       # Entry points
│   ├── mcp-setup.md       # Generic MCP config
│   └── enterprise.md      # Admin requirements
├── claude-code/           # Vendor: Claude Code
├── kiro/                  # Vendor: Kiro
├── gemini-cli/            # Vendor: Gemini CLI
└── mcp/                   # Protocol reference
    ├── tools-reference.md
    └── tutorials.md
CONTRIBUTING.md（開発ワークフロー）

目的： このリポジトリの変更方法を説明します。

必ず含める内容：

  • クローンとローカル開発のセットアップ
  • ローカルで変更をテストする方法（--plugin-dir など）
  • 検証チェックリスト
  • PR の手順

含めてはいけない内容：

  • プラグイン／パワーのアーキテクチャ全体（→ docs/）
  • ユーザー向けチュートリアル（→ docs/）

ベンダードキュメントの基準

docs/ 内の各ベンダーディレクトリは、次のパターンに従います。

必須ファイル
ファイル目的
overview.mdこのインテグレーションの概要、利用する理由、インストール方法
*-development.md新しいプラグイン／パワー／拡張機能の構築方法
個別コンポーネントのドキュメントプラグイン／パワーごとに 1 ファイル
overview.md の標準セクション
## What are [Plugins/Powers/Extensions]?
## Why Use [Plugins/Powers] vs Direct MCP?
## Available [Plugins/Powers]
## Installation
## Authentication
## Related
ベンダー固有のメタデータ
ベンダー設定形式場所
Claude Codeplugin.json.claude-plugin/plugin.json
KiroPOWER.md のフロントマターPOWER.md
Gemini CLIJSON 拡張機能gemini-extension.json

相互参照のパターン

リンク形式
  • docs/ 内：相対パスを使用
  • README から docs/ へ：docs/ を付けてリンクします [テキスト](docs/claude-code/overview.md)
  • 外部リンク：完全な URL を使用します [テキスト](https://developers.miro.com)
必須の「関連」セクション

各ドキュメントファイルの末尾には、「関連」セクションを含めてください。

## Related

- [Overview](overview.md) - Introduction to this integration
- [Tools Reference](../mcp/tools-reference.md) - MCP tool documentation
相互リンク

ドキュメント A からドキュメント B にリンクする場合、ドキュメント B の「関連」セクションからドキュメント A にもリンクしてください。

検証ガイドライン

ドキュメントの変更をコミットする前に、次の項目を確認してください。

コンテンツの確認
  • コンテンツが重複していない（代わりにリンクを使用）
  • コンテンツが適切なドキュメントに記載されている（README、docs/、CONTRIBUTING のいずれか）
  • ベンダー基準に沿ったセクションがすべて含まれている
リンクの確認
  • すべての内部リンクが有効
  • 「関連」セクションに相互リンクがある
  • 外部リンクに HTTPS を使用
書式の確認
  • コードブロックに言語が指定されている
  • 表の書式に一貫性がある
  • 折りたたみ要素のタグが一致している

関連項目

  • references/patterns.md - 書式設定パターン（表、折りたたみ、コードブロック）

コメント

Markdown 対応