mcpField
M
mvpfy-document

mvpfy-document

github.com/promovawebドキュメント8227 回インストール10 週間前に更新
リポジトリ

mvpfy-document について

mvpfy-document はテンプレートとプロジェクトデータを使い、MVP 計画を独立した Markdown 文書にまとめます。MVP 仕様を作成する人向けで、内容の充足度や公開品質の確認も扱います。

主な機能

  1. 01テンプレートから MVP 文書を作成
  2. 02プロジェクトファイルに基づく要件分析の再生成
  3. 03不足情報や対象外項目の明示
  4. 04文書のチェックと検証
  5. 05編集および電子書籍公開のガイド

活用シーン

  1. 01MVP の回答を単一文書に集約
  2. 02プロジェクトデータに基づく要件更新
  3. 03ユーザー向け電子書籍の準備と検証

インストール

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

$npx skills add https://github.com/promovaweb/mvpfy --skill mvpfy-document

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

同梱ファイル

SKILL.md と一緒にインストールされる参考資料やスクリプト。

agents/
openai.yaml
assets/
MVP.template.md
references/
document-rules.md
scripts/
render-company.mjs
requirements-analysis.mjs
validate-company.mjs

詳細

MVP.md の統合

構造の基準として assets/MVP.template.md を使用してください。最終ドキュメントは、会話の履歴がなくても理解できる単一の Markdown ファイルとし、メタデータ、MVP の概要、要件分析、課題、対象者、ペルソナ、スコープ、SaaS、市場、価格、コスト、テクノロジー、マーケティング、指標、実行計画、未解決事項を含めてください。

--project <diretório> を指定して scripts/render-company.mjs を実行し、ファイルを作成または更新してください。このスクリプトは HTML ID mvpfy:section:<id> でセクションを特定し、既存の内容を保持し、データがない場合は「保留」を使用します。requirements-analysis セクションは、.mvpfy/answers.jsonl、.mvpfy/state.json、.mvpfy/existing-project.json から再生成されます。このセクションでは各入力の原文を保持し、モジュール、機能、画面、ツール、人物、データ、フロー、運用要件を整理します。

requirements-specification セクションは、統合のための構成としてテンプレートに残します。受け取った入力の分析に基づいて、各サブセクションを記入してください。このセクションは、利用側のプロジェクトにある補助ファイルに依存しません。

統合する際は、その人の MVP に該当するサブセクションを確認してください。初期の説明、回答、候補項目、見つかったコンテキストにすでに含まれる詳細を記録してください。幅広い説明を短い機能一覧に縮めないでください。現在の MVP に不要なトピックには 現在の MVP には該当しません を使用し、関連するトピックの情報が不足している場合は 保留 とし、不足している内容を具体的に示してください。

書き込み前に、同じスクリプトを --check 付きで実行してください。その後、--project <diretório> を指定して scripts/validate-company.mjs を実行し、検証してください。MVP SaaS の必須項目が記入されている場合に限り、状態を ready にできます。それ以外の場合は preliminary とし、不足項目を列挙してください。

編集および公開前の確認

電子書籍を生成する前に、docs/user/reading-order.txt にユーザー向けのページのみが含まれていることを確認してください。技術リファレンスと仕様は引き続きオンラインで利用できますが、ユーザーガイドには含めません。Hub の参考プロジェクトと構成を比較し、その文章をコピーせずにビジュアルアイデンティティを維持してください。

ページ一式を一つの出版物として読んでください。カタログ、機能一覧、エージェントのメモのように見える箇所を書き直してください。公開する各セクションでは、状況、行動、その効果、ガイダンスの限界を説明する必要があります。リストと表は、並列する情報を整理するために使用し、説明の代わりにしてはいけません。

編集上の確認が終わったら、PDF と EPUB を生成し、生成物を読んでから、サブモジュールと Hub のバリデーターを実行してください。ビルドが成功すればファイルが生成されたことは確認できますが、文章の品質が保証されるわけではありません。

PDF、EPUB、マニフェストには、フレームワークと同じ SemVer を使用してください。VERSION が正式なバージョンの基準であり、ebooks/VERSION はビルドで照合されるミラーにすぎません。値が一致しない場合は、形式を生成または公開する前にバージョンを修正してください。

正準の順序については document-rules.md を参照してください。

コメント