Design Doc, ADR, RFC
趣味レベルの開発であっても、最近では DesignDocやADRを書き残すようにしています。
ナイモノは読めないから
Design Doc のような機能に関する仕様や、
ADR のような全体のアーキテクチャに関する仕様など、
意思決定は山ほどあります。
作った結果についてはコードベースに残っているため、
機能の振る舞いや具体的な設計については（AIが）読めばわかります。
しかし作っていないもの、例えば見送ったものについては読み取ることができません。
仕様を決めるにあたって、見送る過程の議論・思考は貴重な情報 で、
それを含めて意思決定です。
この ナイモノを言語化して記録 をすることで、人やAIライクに仕事を進めることができます。
リポジトリにコミット
その言語化したテキストは、リポジトリにそのままコミットして残す様にしています。
これはリポジトリに入っていることで、わざわざAIにプロンプトチューニングしなくてもそれを踏まえて設計してくれる、
そんな気がします。（笑）
（GitHub issueなど外部に纏めるよりもシームレスと思ったり）
実際私の個人開発において、開発した機能仕様について毎回AIに伝える必要がなくなり、
機能名を改善する際に文脈コンテキストを踏まえて作ってくれます。
これは結構助かりました。
個人ではなくチームにおいては、さらに良い点があります。
チームで開発すると効率化を求めると、情報格差 が生まれる場合があります。
ある人は知っているけど、あの人はしらない。
そういう情報格差があると、レビュー精度だけでなくコミュニケーションで困ることもあります。
その情報格差を平すために、この資料を残すことは大事なことと思います。
意見を募る RFC のファイルも同じくリポジトリにコミットしておくと良いでしょう。
個々人の意見の集合体が記録されることで、チームとしてはどういう方向に舵を切ったのかを知ることができます。
どういう考慮があったか、どういう懸念があったか、そういう背景を残すというのは将来の自分たちの首を絞めずに済みます。
終わりに
資料を書く面倒さは、今の時代はほぼノーコストです。
メンテナンスしないために、その時点のスナップショットと扱うとやりやすいです。
ぜひ、仕様をリポジトリにコミットしましょう。
-
s※ ログイン不要で投稿できます。
※ 同じブラウザから投稿を削除できます。
0
読み込み中...
関連する記事
タグ「仕事」の記事
Codex や Claude のデスクトップアプリにあるピン留め機能が気に入っています。 ピン留めというメタファ 髪の毛を束にしてまとめるためのピン留めや、 コルクボードに紙を止めるためのピン留めなど、 何かを固定するというメタファがピン留
今日、天ぷら屋さんで昼食を取りました。 お隣の席が職場グループ8人組でした。 なんとなく、尼崎での思い出が蘇りました。 毎日一緒 尼崎にある職場で出勤していた頃、その当時は私はまだ独身でした。 同じチームで働く4名ぐらいのメンバーと、 毎日
今お世話になっている職場とも、来年2月出産に備えて手前で休むことになります。 出産後に復帰させてもらえるのか不透明なのと、ちょうど良い区切りでもあるので、職を探しています。 人に寄り添うUIデザイン 私は主にWebフロントエンドでお仕事させ
2026年08月07日
タグ「個人開発」の記事
個人ブログを見つけて、読んで、シェアするアプリ こぶりー に、RSSがないブログ も掲載できるようにしました！🎉 別途サイト内お知らせにもお伝えする予定です。 これで（私の）お気に入りのRSSがないブログも、こぶりーで見つけることができる
2026年10月04日
趣味で作っているWebアプリにて、実装したものを細かくPull Request（以降、PR）を作成します。 PR に対して、機械的にチェックするCIチェックリストがあります。 個人的に気に入っているものを紹介します。 未使用コードの削除 実
個人ブログを見つけて、読んで、シェアするアプリ、こぶりー に、ちょっとした改善を入れました。 主に運営側向けの機能なので、こぶりーだより ではなく、ここで書きます。笑 ※ 最近ここの境界が曖昧になっていてよろしくない... 共有先にこぶりー
2026年09月23日