mcpField
P
pm-the-docs

pm-the-docs

github.com/supabaseドキュメント114.3k57 回インストール今日更新
リポジトリ

pm-the-docs について

ドキュメントチームが執筆前に新規ドキュメントの枠組みと構成を決めるためのスキルです。対象読者、製品段階、範囲、コンテンツ種別、配置、前提条件や、ドキュメント PM への相談要否を整理します。

主な機能

  1. 01対象読者、製品段階、目的の整理
  2. 02コンテンツ種別と情報配置の選択
  3. 03複数リポジトリにまたがる範囲の評価
  4. 04確認済みの事実と推測の区別
  5. 05ドキュメント PM への相談要否の判断

活用シーン

  1. 01新しいドキュメントページやリリース内容の範囲決定
  2. 02ページの配置と前提条件の選択
  3. 03複数の製品リポジトリにまたがる作業の確認
  4. 04不明確な範囲や製品段階の判断を相談

インストール

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

$npx skills add https://github.com/supabase/supabase --skill pm-the-docs

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

同梱ファイルreference/write-the-docs-checklist.mdreference/universe-lookup.md

詳細

ドキュメントの PM

「ドキュメントを書く」チェックリストの Frame と Shape のステージを支援します(reference/write-the-docs-checklist.md にミラーされています)。執筆を始める前に、通常はドキュメント PM が判断する対象読者、プロダクトのステージ、横断的なスコープを扱います。

呼び出すタイミング

  • 新しいドキュメントページやローンチに着手し、執筆前にプロダクトのステージ、対象読者、「理由」を明確にする必要がある場合(Frame)。
  • ページのコンテンツタイプ、IA での配置、前提条件を決める場合(Shape)。
  • ローンチが複数のプロダクトリポジトリ(CLI、Auth、マイグレーション、プラットフォームなど)にまたがるか判断する場合は、reference/universe-lookup.md を参照してください。
  • ドキュメントに関する質問をセルフサービスで解決できるのか、ドキュメント PM の承認が必要なのか判断できない場合。

コンテンツ自体の執筆には使用しないでください(write-the-docs を参照)。既存ページの再構成(edit-the-docs を参照)、スニペットの実行(test-the-docs を参照)、ドキュメントアプリのアーキテクチャや IA 配置の仕組み(ask-the-docs を参照)にも使用しません。

参考ファイル

ファイル内容
reference/write-the-docs-checklist.md6 ステージの執筆チェックリストのミラー
reference/universe-lookup.mdリポジトリ横断のプロダクト検索:機能ゲート、ユニバースアクセラレーター、OSS パス

スコープ/ステージ/対象読者に関する質問への回答

  1. reference/write-the-docs-checklist.md で該当するステージを読みます。チェックボックスには、何を決める必要があるかが明記されています。
  2. 機能に関する既存のコンテキストを確認します。リンクされた issue/プロジェクト、PRD、リリース済みコード、PR などです。コードと PRD の記述が食い違う場合、動作に関する説明ではコードを優先します。
  3. スコープが複数のサービス(CLI、Auth、マイグレーション、Dashboard、プラットフォームなど)にまたがる可能性がある場合は、Frame/Shape を確定する前に、reference/universe-lookup.md の 機能ゲートに従います。アクセスできる場合のみ universe を使用し、そうでなければ OSS パスを使用します。検索したリポジトリを記録します。
  4. チェックリストの質問に直接回答します。プロダクトのステージ、対象読者と達成したいこと、一文で表す「理由」、コンテンツタイプ、IA での配置、前提条件です。
  5. 確認済みの事実(チケット/PRD/コードに記載されている内容)と推論(最も妥当と考える解釈)を区別します。推論を確定事項として提示せず、推論であることを明示します。
  6. 組織レベルで本当に未決定の事項(ドキュメント執筆者が判断することではない事項)がある場合、体裁を整えるために回答を捏造せず、未決定であることと、代わりに誰が決めるべきかを伝えます。

セルフサービスか、エスカレーションか

チェックリストが明確で、標準があり、ステージと対象読者をすでに把握している場合は、セルフサービスで対応します。

スコープやステージが不明確な場合、レビューの手順が必要な場合、基準が曖昧な場合、またはローンチが横断的な領域(クイックスタート、API キー、チュートリアル、オンボーディング、プラットフォームの概念)に関わる場合は、ドキュメントチームの PM にエスカレーションします。チェックリストのミラーにある「Ask the Docs PM」の全セクションを参照してください。

関連スキル

  • ask-the-docs — IA での配置とドキュメントアプリのアーキテクチャ(Shape ステージ)。リポジトリ横断のプロダクト検索はここではなく、universe-lookup.md にあります。
  • write-the-docs — Frame/Shape が確定した後の執筆
  • test-the-docs — Docker で分離したローカルスタックに対するスニペットの実行と、検証レポートの作成
  • edit-the-docs — 既存ページの再構成と改善
  • review-the-docs — セルフレビューと PR レビューの各ステージ

コメント