docs-workflow

docs-workflow

最終更新日: 2026-01-11 目的: プロジェクトのライフサイクル全体を通じてドキュメントを管理します

---

概要

このスキルでは、次のことができます。

• 初期化：新しいプロジェクトのドキュメントを作成します（CLAUDE.md、README.md、docs/）
• 保守：CLAUDE.mdを実際のプロジェクトの状態に合わせて維持します
• 監査：すべてのドキュメントについて、古くなっていないか、リンク切れがないか、バージョンが最新かを確認します

コマンド

コマンド	目的
/docs	メインのエントリーポイントです。利用可能なサブコマンドを表示します
/docs-init	CLAUDE.md + README.md + docs/ の構成を作成します
/docs-update	すべてのドキュメントを監査し、保守します
/docs-claude	CLAUDE.mdのみをスマートに保守します

クイックスタート

新しいプロジェクト

# In a new project directory
/docs-init

これにより、次の処理が行われます。

1. プロジェクトの種類を検出します（Cloudflare Workers、Next.js、汎用）
2. 適切なテンプレートからCLAUDE.mdを作成します
3. README.mdがない場合は作成します
4. 必要に応じてdocs/ディレクトリをひな形から作成します

既存のプロジェクト

# Audit all documentation
/docs-update

# Or just maintain CLAUDE.md
/docs-claude

---

作成されるもの

CLAUDE.md

Claude Code向けのプロジェクト固有のコンテキストで、以下が含まれます。

• プロジェクトの概要と技術スタック
• 開発環境のセットアップコマンド
• アーキテクチャの概要
• 主要なファイルの場所
• 一般的なタスクとワークフロー

利用可能なテンプレート：

• CLAUDE-cloudflare.md - Cloudflare Workers + Vite + D1プロジェクト
• CLAUDE-nextjs.md - Next.js App Routerプロジェクト
• CLAUDE-generic.md - その他すべての種類のプロジェクト

README.md

次の内容を含む標準的なREADMEです。

• プロジェクト名と説明
• インストール／セットアップ手順
• 使用例
• 設定
• コントリビューションガイドライン

docs/ ディレクトリ（任意）

ひな形として作成されるドキュメント構成です。

• docs/ARCHITECTURE.md - システムアーキテクチャ
• docs/API.md - APIドキュメント
• docs/DATABASE.md - データベーススキーマ

---

スマート保守

/docs-claudeの機能

CLAUDE.mdの保守コマンドでは、次の項目を確認します。

1. 技術スタックの一致

   • CLAUDE.mdに記載された技術はpackage.jsonの内容と一致していますか？
   • 記載されたバージョンは現在も正確ですか？

2. 参照ファイル

   • CLAUDE.mdに記載されたパスは現在も存在しますか？
   • 記載されていない重要な新規ファイルはありますか？

3. セクションの鮮度

   • 「最終更新日」は最近の日付ですか？
   • 古くなったパターンやコマンドはありませんか？

4. 重要なルール

   • 検出された技術スタックに必要な重要なルールが記載されていますか？
   • 例：Cloudflareプロジェクトでは、wrangler.jsoncのパターンに触れている必要があります

/docs-updateの機能

次の項目を含む、ドキュメント全体の監査を行います。

1. 日付の鮮度

   • ドキュメントの日付とgit履歴を比較します
   • 30日を超えて更新されていないドキュメントにフラグを立てます

2. バージョンの記載

   • 記載されているnpmパッケージのバージョンを確認します
   • 古くなったバージョンの更新を提案します

3. リンク切れ

   • 内部のMarkdownリンクを検証します
   • 参照先のファイルが存在するか確認します

4. 重複

   • ファイル間で重複している内容を特定します
   • 内容の統合を提案します

5. 孤立したファイル

   • どこからも参照されていないドキュメントを見つけます
   • アーカイブまたは削除を提案します

---

プロジェクトの種類の検出

このスキルは、次の項目を確認してプロジェクトの種類を自動検出します。

判定項目	プロジェクトの種類
wrangler.jsoncまたはwrangler.toml	Cloudflare Workers
next.config.jsまたはnext.config.ts	Next.js
どちらもなし	汎用

その他の判定項目もテンプレートの内容に影響します。

• package.jsonの依存関係（React、Viteなど）
• データベース設定ファイル（drizzle.config.ts、prisma/schema.prisma）
• 認証設定（clerk、better-auth）

---

他のスキルとの連携

• project-workflow：/plan-projectの後に/docs-initを実行して、ドキュメントを追加します
• project-planning：生成されたIMPLEMENTATION_PHASES.mdはCLAUDE.mdで参照されます
• cloudflare-worker-base：CloudflareテンプレートにはWorkers固有のパターンが含まれます

---

ベストプラクティス

各コマンドを実行するタイミング

状況	コマンド
新しいプロジェクト	/docs-init
大きな変更の後	/docs-claude
リリース前	/docs-update
毎月の保守	/docs-update

CLAUDE.md ガイドライン

1. 最新の状態を保つ - 変更時に「最終更新日」を更新してください
2. プロジェクト固有の内容に絞る - 一般的な技術ドキュメントを重複させないでください
3. よくあるタスクを含める - 頻繁に実行するコマンドを記載してください
4. 重複させず、参照する - 詳細な内容は docs/ へのリンクを記載してください

---

テンプレート

テンプレートは、このスキル内の templates/ にあります。

templates/
├── CLAUDE-cloudflare.md    # Cloudflare Workers projects
├── CLAUDE-nextjs.md        # Next.js projects
├── CLAUDE-generic.md       # Generic projects
└── README-template.md      # Standard README

テンプレートでは、次のプレースホルダーを使用します。

• {{PROJECT_NAME}} - package.json またはフォルダー名から検出されます
• {{DATE}} - 現在の日付
• {{TECH_STACK}} - 検出されたテクノロジー