sc-document

ドキュメント生成スキル

コード、API、機能に特化したドキュメントです。

クイックスタート

# Inline documentation
/sc:document src/auth/login.js --type inline

# API reference
/sc:document src/api --type api --style detailed

# User guide
/sc:document payment-module --type guide

動作フロー

1. 分析 - コンポーネントの構造と機能を調べます
2. 特定 - ドキュメントの要件と対象読者を判断します
3. 生成 - 適切なドキュメントの内容を作成します
4. 書式設定 - 一貫性のある構造とパターンを適用します
5. 統合 - 既存のドキュメントとの互換性を確保します

フラグ

フラグ	型	デフォルト	説明
--type	string	inline	inline、external、api、guide
--style	string	detailed	brief、detailed

根拠の要件

このスキルでは、確かな根拠は必要ありません。成果物は以下のとおりです。

• 生成されたドキュメントファイル
• インラインコードコメント
• API リファレンス資料

ドキュメントの種類

インライン（--type inline）

• JSDoc／docstring の生成
• パラメーターと戻り値の説明
• 関数レベルのコメント

外部（--type external）

• 独立したドキュメントファイル
• コンポーネントの概要
• 統合ガイド

API（--type api）

• エンドポイントのドキュメント
• リクエスト／レスポンスのスキーマ
• 使用例

ガイド（--type guide）

• ユーザー向けチュートリアル
• 実装パターン
• よくあるユースケース

スタイルのオプション

簡潔（--style brief）

• 簡潔な説明
• 必要な情報のみ
• クイックリファレンス形式

詳細（--style detailed）

• 包括的な説明
• 詳細な例
• エッジケースへの対応

例

インラインコードのドキュメント

/sc:document src/auth/login.js --type inline
# JSDoc with @param, @returns, @throws

API リファレンス

/sc:document src/api --type api --style detailed
# Full endpoint docs with examples

ユーザーガイド

/sc:document payment-module --type guide --style brief
# Quick-start tutorial with common patterns

コンポーネントのドキュメント

/sc:document components/ --type external
# README.md for component library

MCP 統合

PAL MCP（品質と調査）

ツール	使用する場面	目的
mcp__pal__codereview	API ドキュメント	ドキュメントの正確性を確認します
mcp__pal__apilookup	外部 API	最新の API ドキュメントを取得します
mcp__pal__chat	執筆支援	複雑な説明について支援を受けます
mcp__pal__consensus	スタイルの判断	ドキュメントの方針を複数のモデルで検証します

PAL の使用パターン

# Verify documentation accuracy
mcp__pal__codereview(
    review_type="quick",
    step="Reviewing API documentation for accuracy",
    findings="Parameter descriptions, return types, examples",
    relevant_files=["/docs/api/auth.md"]
)

# Get current API docs for external integration
mcp__pal__apilookup(
    prompt="Get current Stripe API documentation for payment intents"
)

# Writing assistance for complex topics
mcp__pal__chat(
    prompt="Help me explain the OAuth2 authorization code flow clearly for developers",
    model="gpt-5.2"
)

Rube MCP（公開と共同作業）

ツール	使用する場面	目的
mcp__rube__RUBE_SEARCH_TOOLS	ドキュメントプラットフォーム	Notion、Confluence、GitBook を探します
mcp__rube__RUBE_MULTI_EXECUTE_TOOL	公開	ドキュメントをプラットフォームに公開します
mcp__rube__RUBE_REMOTE_WORKBENCH	大量のドキュメント	大規模なコードベースのドキュメントを生成します

Rube の使用パターン

# Publish documentation
mcp__rube__RUBE_MULTI_EXECUTE_TOOL(tools=[
    {"tool_slug": "NOTION_CREATE_PAGE", "arguments": {
        "title": "API Reference: Authentication",
        "content": "## Endpoints\n### POST /auth/login\n..."
    }},
    {"tool_slug": "CONFLUENCE_CREATE_PAGE", "arguments": {
        "space": "DEV",
        "title": "Auth API Documentation",
        "content": "..."
    }}
])

# Notify team of new docs
mcp__rube__RUBE_MULTI_EXECUTE_TOOL(tools=[
    {"tool_slug": "SLACK_SEND_MESSAGE", "arguments": {
        "channel": "#documentation",
        "text": "New API docs published: Authentication endpoints"
    }}
])

# Bulk generate docs
mcp__rube__RUBE_REMOTE_WORKBENCH(
    thought="Generate JSDoc for all exported functions",
    code_to_execute='''
import os
# Process all JS files and generate documentation
# Use invoke_llm for each function
'''
)

フラグ（拡張）

フラグ	型	デフォルト	説明
--pal-review	bool	false	PAL を使用してドキュメントの正確性を確認します
--publish	string	-	Rube 経由で公開します（notion、confluence、gitbook）
--notify	string	-	Rube 経由で通知します（slack、teams、email）

ツールの連携

• Read - コンポーネントの分析
• Grep - 参照情報の抽出
• Write - ドキュメントの作成
• Glob - 複数ファイルにわたるドキュメント作成
• PAL MCP - 正確性の確認、API の検索、執筆支援
• Rube MCP - 公開、通知、大量生成