mcpField
0
031-architecture-adr-functional-requirements

031-architecture-adr-functional-requirements

github.com/jabrena開発456289 回インストール1 日前に更新
リポジトリ

031-architecture-adr-functional-requirements について

CLIやREST APIの機能要件と技術的な決定事項を対話形式で整理し、確認後にADRへ記録するスキルです。質問を少数ずつ行い、要約の確認とユーザーの承認を経て文書を作成します。

主な機能

  1. 01CLIとAPIの対象範囲の特定
  2. 02段階的な要件ヒアリング
  3. 03技術的決定事項の整理
  4. 04ADR作成前のユーザー確認
  5. 05承認後のADR生成

活用シーン

  1. 01新しいCLIの要件整理
  2. 02REST APIの決定事項の記録
  3. 03CLIとAPIにまたがる要件の明確化

インストール

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

$npx skills add https://github.com/jabrena/plinth --skill 031-architecture-adr-functional-requirements

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

同梱ファイルreferences/031-architecture-adr-functional-requirements.md

詳細

機能要件の ADR を作成する（CLI および／または REST API）

構造化された対話を通じて、関係者がコマンドラインツール、REST/HTTP API、または両方のインターフェースに関する技術的な意思決定と機能要件を洗い出し、文書化できるよう支援します。これは対話型の SKILL です。ADR はその対話の記録であり、対話そのものではありません。可能な場合は現在のワークスペースから CLI と API のどちらかを推測し、不明な場合は簡潔な確認質問をします。現在のセッションで明示的に利用できる会話内容とリポジトリ内のファイルのみを使用してください。

この Skill で扱う内容

  • インターフェースの特定：CLI、REST/HTTP API、または両方（推測と確認）
  • 初期コンテキスト：目的、ユーザー／利用者、制約、スケジュール、負荷（関連する場合は API）
  • 機能要件：インターフェース固有のワークフロー、入出力、リソース、エラー
  • 技術的な意思決定：言語／フレームワーク、REST の項目（API 設計、認証、データ、インフラ、テスト／監視）および／または CLI の項目（アーキテクチャ、データ／統合、テスト／配布）
  • ADR 作成前の意思決定の統合と検証
  • ADR ドキュメントの生成と次のステップ

制約

少しずつ対話しながら要件を確認し、回答を踏まえて進めてください。十分な対話を行い、ユーザーの確認を得てから ADR を作成してください。

  • 必須：ADR に正確なタイムスタンプを記載するため、開始前にローカルシェルの date コマンドを使用してください。
  • 必須：現在のセッションで同梱の参照テンプレートを読み込んでください。ユーザーが再度提供しない限り、前のセッションの内容は無視してください。
  • 必須：一度に尋ねる確認質問は 1 つか 2 つにしてください。すべてを一度に尋ねてはいけません。
  • 必須：ADR の作成を提案する前に、要約が正確かどうかをユーザーに確認してください（「要件を正確に反映していますか？」）。
  • 必須：ADR を生成する前に、ユーザーが続行を確認するまで待ってください。

このスキルを使用する場面

  • 機能要件の ADR を作成する
  • 機能要件を文書化する
  • 機能要件を記録する
  • ADR で機能要件を生成する
  • ADR の機能要件について、CLI と REST のどちらにするかを決定する

ワークフロー

  1. 現在の日付を取得する

要件確認を始める前にローカルシェルの date コマンドを使用し、ADR のタイムスタンプにその結果を使用してください。

  1. 参照資料を読み込み、インターフェースの範囲を特定する

このスキルの references/031-architecture-adr-functional-requirements.md を読み込み、現在のワークスペースから CLI／API の範囲を推測してください。不明な場合は簡潔な確認質問をします。

  1. 対話形式で要件を確認する

少しずつ対話しながら、CLI、REST API、または両方の機能要件と技術的な意思決定を確認してください。

手順の制約：

  • 要件確認の質問をすべて一度に尋ねてはいけません。
  • ADR の生成を提案する前に、要約をユーザーに確認してください。
  1. 明示的な確認後に ADR を生成する

ユーザーが続行を確認した場合に限り、ADR ドキュメントを生成し、簡潔な次のステップを提示してください。

参照資料

詳細なガイダンス、例、制約については、references/031-architecture-adr-functional-requirements.md を参照してください。

コメント

Markdown 対応