SpecDojo Handbook

SpecDojoは、仕様駆動開発のためのドキュメントフレームワーク です。 プロダクトの構築・改修に必要なドキュメントを体系化し、 記述規約、サンプル、生成AI向け指示テンプレート、ツールを通じて、 プロダクトのライフサイクル全体を一貫して支援します。

仕様駆動開発に適した、生成AIが扱い易く、人も理解できて、記述も負担にならない、 そんなドキュメントのフレームワークを目指しています。

SpecDojo Handbook では、仕様駆動開発のためのドキュメントの、

• 作成ルールとガイドライン
• 生成AI向け指示テンプレート
• サンプルドキュメント (おばあちゃんの駄菓子屋)
• 作成支援ツール

を、オープンソース・テンプレートリポジトリとして公開しています。

ホームページはこちら SpecDojo Handbook

Quick Start

• GitHubのテンプレートプロジェクトとして公開していますので、spec-dojo-handbookリポジトリの右上のUse this templateボタンからCreate a new repositoryクリックして新規リポジトリを作成してください。

• spec-dojo-handbookリポジトリの右上のCodeボタンからDownload ZIPをクリックして、ファイルをダウンロードし、docs/ja/handbook以下をプロジェクトに取り込んでください。

ドキュメントガイド

• 構成ガイドでは、SpecDojoで扱うドキュメントの全体構成について説明します。
• 内容ガイドでは、各ドキュメントの内容について説明します。
• 編集ガイドでは、エディターやツールの使い方の豆知識を説明します。

ディレクトリ構成

docs/
├── ja/                   # 多言語化対応（将来: en/ etc.）
│   ├── handbook/
│   │   ├── guidelines/   # ドキュメント作成ガイド
│   │   ├── rules/        # ドキュメント記述規約
│   │   └── instructions/ # 生成AIへの指示テンプレート
│   ├── sample-gcs-project-docs/ # おばあちゃんの駄菓子屋サンプルドキュメント
│   │   ├── prj-0001/ # プロジェクトの構築や改修時に追加されるドキュメント群
│   │   │   ├── 010-プロジェクト概要/
│   │   │   ├── 020-プロジェクトスコープ/
│   │   │   ├── 030-プロジェクト課題と解決アプローチ/
│   │   │   ├── 040-プロジェクトマネジメント/
│   │   │   └── 090-決定記録/
│   │   └── prj-0002/ ...
│   └── sample-gcs-product-docs/ # おばあちゃんの駄菓子屋サンプルドキュメント
│       ├── 010-業務仕様/
│       ├── 020-外部IF仕様/
│       ├── 030-アーキテクチャ/
│       ├── 040-システム設計/
│       ├── 050-業務受入条件/
│       ├── 060-非機能要件/
│       ├── 070-システム受入条件/
│       ├── 080-テスト/
│       ├── 090-移行設計/
│       └── 100-運用設計/
└── en/                   # 将来の英語ドキュメント用ディレクトリ

ライセンス

本リポジトリは MIT ライセンスです。

著者 / 問い合わせ

Author: @naoji3x
Issue もしくは Pull Request にてフィードバックを歓迎します。