開発とドキュメントのルール¶

このリポジトリは2～3人の趣味開発で使う。変更の意図、動作確認、参照先が分かる状態を保つ。形式的な承認や書類は増やさない。

変更の進め方¶

1. 目的ごとにブランチを作り、変更範囲を把握しやすくする。
2. 実装を変えたら、関係するテストまたはビルドを実行する。実機でしか確認できない内容は、その旨を記録する。
3. 動作・設定・操作手順が変わったら、対応する文書を同じ変更で直す。
4. 共有時には変更内容、確認結果、残る確認事項を短く伝える。レビュー方法は変更の影響に合わせて決める。

文書の役割¶

• README.md: リポジトリの入口と主要な実行方法。
• SETUP.md: CM4の初期セットアップと操作手順。
• doc/overview.md: 現在の構成と詳細文書への入口。
• doc/*_packet.md、各機能の文書: 現在の実装に対応する仕様と運用上の注意。
• doc/work_log.md: 日付付きの調査結果、実機作業、変更理由。仕様の正本ではない。
• doc/history/: 過去の計画資料の保存先。現在の操作手順として参照しない。

仕様書と手順書には**現在の仕様だけ**を書く。過去の形式、旧構成との比較、変更の経緯を追加しない。変更理由や実験値を残す必要がある場合は作業ログに記録する。未実装の案は現在の仕様として書かない。

文書の記述は日本語・UTF-8とし、同じ説明を複数の文書に複製せず、詳しい文書へリンクする。コードや設定との食い違いを見つけたら、実装を確認して文書を直す。