UnmappedIsland ドキュメント
このディレクトリにはゲーム開発に関するすべてのドキュメントが格納されています。
ディレクトリ構成
企画・設計・仕様といった工程ではなく、扱っている領域でフォルダを分けています。 領域は検討の進み具合によらず変わらないため、ドキュメントの成熟度が上がっても別フォルダへ移す必要がありません。
docs/
├── concept/ # コンセプト(企画の核となる考え方。ターゲット・マネタイズ等を含む)
├── ui/ # UI/UX(画面レイアウト、モック、スクリーンショット)
├── engine/ # ルール・エンジン(WorldCodexのYAML文法そのもの、汎用サブシステム)
├── world/ # 実際にゲームに登場する内容(地形・気候・アイテムなど、文法を使って
│ # 表現された具体的なゲーム内容)
└── diagnostics/ # 診断・統計レポート(実装の挙動を計測したスナップショット。設計判断ではなく測定値)
各フォルダの用途
| フォルダ | 内容 |
|---|---|
| concept/ | ゲームコンセプト、目指す体験、ターゲット、マネタイズ計画など |
| ui/ | 画面レイアウト、モック、UI/UX設計 |
| engine/ | WorldCodex(YAML)の文法リファレンス、汎用サブシステム(レシピ・コンテナ・耐久値・アクション使い分け)の設計 |
| world/ | 気候、地形生成、探索・道、アイテムなど、実際にこのゲームに登場する具体的な内容 |
| diagnostics/ | 実装をシミュレーションして計測した統計レポート(tests/diagnostics/のRUN_CLIMATE_STATS環境変数付きテストで再生成する測定値のスナップショット。設計そのものではない) |
diagnostics/ のみ性質が異なり、設計判断ではなく実装の測定結果を格納します
(詳細は diagnostics/README.md)。
各ドキュメントの構造(見出し・節番号・概要の定型・実装状況と確定度の表記)は
DocumentStyle.md に従います。印の無い節は暫定で、覆すのに判断が要る節
だけが 【確定】 を持ちます(同 6 節)。文書まるごとが確定のものは、節ごとの印ではなく題名の直後で
1回宣言します(同 6.2 節)。文書ごとの内訳は npm run stats:docs が出します——このフォルダの外に
置かれた確定節も同じ表に並びます(同 10 節)。
src/ のコードをどこへ置き、何を知ってよいかは CodeStructure.md、
TypeScriptをどう書くか(Prettier・ESLint・tsc で強制できない分)は
CodingConventions.md が決めます。どちらもドメインから画面まで全体に
掛かるので、領域別のフォルダには入れずここに置いています。
過去の失敗・不採用の決定のうち、繰り返さないために残す価値があるものは
DesignNotes.md が1箇所で持ちます。項目の見出しが指す先は領域を跨ぎ、
このフォルダ分類そのものを決めた項目も含むので、これも領域別のフォルダには入れずここに置いています。
このゲームは複数のAIエージェントが同時に開発しています。 その仕組みの全体像——誰が何をして、
人間はどこで決めるのか——は ParallelAgents.md、そこへ辿り着くまでに作り方を
どう変えてきたかは HowWeGotHere.md にあります。
無くても完成を宣言できるが、いつか実装したいものは Someday.md が1箇所で持ちます
(残りの作業量には数えません)。
備考: ユーザー向けのゲーム内ヘルプやチュートリアルはゲームコンテンツとして実装するため、このフォルダには含まれません。