仕様書の構成案
仕様書は以下のセクションで構成してください:
- •概要: このプログラム/機能が解決する課題と目的。
- •主要機能: 実装されている主要な機能のリスト。
- •技術スタック: 使用ライブラリ(pandas, OpenCV等)とその理由。
- •データ構造/フロー: 入出力データや処理の流れ。
- •未実装/今後の課題: 現在の制限事項。
記述ルール
- •常に
docs/SYSTEM_DESING.md(またはプロジェクトルートの SPEC.md)を更新対象とする。 - •ソースコードは
src/real_state_geo_coreを対象とする。(Pythonパッケージのソースコードのみ) - •実装コードから乖離がある場合、コードの事実を優先して仕様書を修正する。
- •専門用語には必要に応じて注釈を入れ、日本語で分かりやすく記述する。