mcpField

hackathon-doc-writer

github.com/bernieweb3ドキュメント42 回インストール
リポジトリ

hackathon-doc-writer について

ハッカソンプロジェクト向けに、ADR、PRD、機能仕様書を作成するスキルです。文書の種類に応じた共有テンプレートを使い、未記入の項目を示します。

主な機能

  1. 01ADR、PRD、機能仕様書の作成
  2. 02対応する共有テンプレートの使用
  3. 03未記入項目をTBDとして明示
  4. 04テスト可能な機能受け入れ条件の記述

活用シーン

  1. 01確定したMVP範囲の文書化
  2. 02アーキテクチャ決定の記録
  3. 03実装前の機能仕様書作成

インストール

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

$npx skills add https://github.com/bernieweb3/hackathon-ai-devkit --skill hackathon-doc-writer

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

詳細

hackathon-doc-writer

目標

ハッカソンプロジェクト向けに、適切なテンプレートを使用して構造化された技術ドキュメント(ADR、PRD、機能仕様書)を作成します。


トリガー条件

次の場合にこのスキルを使用します:

  • MVP の範囲が確定し、PRD に記録する必要がある
  • アーキテクチャ上の決定がなされ、ADR に記録する必要がある
  • 実装開始前に、特定の機能について正式な仕様書を作成する必要がある
  • hackathon-scope-cutter の完了後、フェーズ 4(プロジェクト計画)で呼び出される
  • 実装中に新たなアーキテクチャ上の決定がなされた場合は、いつでも再度呼び出せる

入力

入力型必須説明
document_typeenumはい次のいずれか:ADR、PRD、feature-spec
project_titlestringはいプロジェクト名
problem_statementstringはい解決する中心的な問題
mvp_featuresstring[]はいhackathon-scope-cutter による MVP 機能の一覧
tech_stackstring[]はい使用する技術
architecture_decisionsobject[]いいえADR 用:背景と根拠を含む決定の一覧
feature_namestringいいえfeature-spec 用:対象機能の名前
constraintsstring[]いいえ技術上または製品上の制約

出力

出力説明
documentMarkdown 形式で必要事項をすべて記入したドキュメント
document_type生成したドキュメントの種類
missing_fields入力不足により記入できなかったセクション

ルール

  1. 出力構成には、../hackathon-shared-resources/templates/ ディレクトリにある該当テンプレートを使用します。
  2. テンプレートのセクションは省略せず、情報が不足している場合は [TBD] を使用します。
  3. 文章は簡潔で読みやすくし、余分な段落は加えません。
  4. ADR には、アーキテクチャ上の決定を正確に 1 件記録します。
  5. PRD には、推定値であっても成功指標を含めます。
  6. feature-spec には、テスト可能な条件として受け入れ基準を含めます。
  7. [TBD] のセクションはすべて、出力の missing_fields に記載します。

出力形式

document_type: "<ADR|PRD|feature-spec>"

missing_fields:
  - "<section name>"

document: |
  <Full Markdown document content>

例

入力:

document_type: "ADR"
project_title: "AnchorAI"
problem_statement: "How might we provide always-available emotional support for college students?"
mvp_features:
  - "GPT-4 emotional check-in conversation"
  - "Session memory"
tech_stack: ["Python", "FastAPI", "React", "OpenAI API", "Redis"]
architecture_decisions:
  - title: "Session memory storage"
    context: "Need to persist conversation summaries between sessions"
    options: ["Redis (in-memory)", "SQLite (file)", "OpenAI conversation history API"]
    decision: "Redis"
    rationale: "Fastest to set up; sufficient for demo; team familiar with it"

出力:

document_type: "ADR"
missing_fields: []
document: |
  # ADR-001: Session Memory Storage

  **Date:** 2025-06-14
  **Status:** Accepted

  ## Context
  AnchorAI must recall emotional context from past user sessions to deliver its core wow factor.
  Memory must persist across browser refreshes for the demo.

  ## Decision
  Use Redis as an in-process session store keyed by a hardcoded demo user ID.

  ## Consequences
  - Positive: Setup takes <30 minutes; team knows Redis well
  - Negative: Data is lost on server restart; not production-ready
  - Risk: Redis unavailable on demo machine → mitigation: fallback to in-memory dict

コンテキストファイル

ナレッジベース
  • ../hackathon-shared-resources/knowledge/hackathon-reference-architecture.md
  • ../hackathon-shared-resources/knowledge/hackathon-mvp-strategy.md
テンプレート
  • ../hackathon-shared-resources/templates/ADR-template.md
  • ../hackathon-shared-resources/templates/PRD-template.md
  • ../hackathon-shared-resources/templates/feature-spec-template.md
プレイブック
  • ../hackathon-shared-resources/playbooks/hackathon-workflow.md

コメント