mcpField
D
documentation

documentation

github.com/dralgorhythm開発12960 回インストール15 週間前に更新
リポジトリ

documentation について

README、API、アーキテクチャ、ユーザーガイドなどの技術文書を作成するスキルです。開発者や文書作成者に、読者に合わせた執筆原則、構成の指針、例を提供します。

主な機能

  1. 01READMEの内容チェック項目
  2. 02API文書で扱う項目
  3. 03アーキテクチャ文書の構成案
  4. 04ユーザーガイド作成の指針
  5. 05簡潔な文章と一覧性の高い構成

活用シーン

  1. 01プロジェクトREADMEの作成
  2. 02APIのリクエストとレスポンスの文書化
  3. 03システムアーキテクチャの説明
  4. 04トラブルシューティングガイドの作成

インストール

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

$npx skills add https://github.com/dralgorhythm/claude-agentic-framework --skill documentation

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

詳細

技術ドキュメント

ドキュメントの種類

README

ユーザーが最初に目にするものです。次の内容を含めます。

  • プロジェクトの機能
  • インストールとセットアップの方法
  • 基本的な使用例
  • 詳細情報の参照先
API ドキュメント
  • エンドポイントとメソッド
  • リクエスト／レスポンスの形式
  • 認証
  • エラーコード
  • 使用例
アーキテクチャドキュメント
  • システムの概要
  • コンポーネント図
  • データフロー
  • 主要な決定事項（ADR）
ユーザーガイド
  • 手順を追った説明
  • スクリーンショット／使用例
  • 一般的なワークフロー
  • トラブルシューティング

執筆の原則

1. 読者を理解する
  • 開発者ですか？ユーザーですか？管理者ですか？
  • すでにどのような知識を持っていますか？
  • 何を達成する必要がありますか？
2. 簡潔にする
  • 短い文
  • 能動態
  • 不要な言葉を削る
3. 説明するより、示す
# Bad
The function handles errors properly.

# Good
The function returns an Error object:
  ```typescript
  const result = await fetchUser(id);
  if (result.error) {
    console.error(result.error.message);
  }


### 4. Structure for Scanning
- Use headings
- Use bullet points
- Use code blocks
- Use tables

## README Template

```markdown
# Project Name

Brief description of what this does.

## Installation

\`\`\`bash
npm install project-name
\`\`\`

## Quick Start

\`\`\`typescript
import { thing } from 'project-name';
thing.doSomething();
\`\`\`

## Documentation

[Full documentation](./docs/)

## Contributing

[Contributing guide](./CONTRIBUTING.md)

## License

MIT

API ドキュメントの例

## POST /api/users

Create a new user.

### Request

\`\`\`json
{
  "email": "[email protected]",
  "name": "John Doe"
}
\`\`\`

### Response

\`\`\`json
{
  "id": "123",
  "email": "[email protected]",
  "name": "John Doe",
  "createdAt": "2024-01-01T00:00:00Z"
}
\`\`\`

### Errors

| Code | Description |
|------|-------------|
| 400 | Invalid request body |
| 409 | Email already exists |

コメント

Markdown 対応