つくったものの結果だけでなく、考えたことや失敗した過程も残していきます。自分のためであり、同じところで詰まる誰かのためでもあります。
結果だけでは残らないもの
oka-projectでは、Webサービスや小さなツールをつくっています。完成したものは制作物一覧やツールサイトに置いていますが、そこに載るのはうまくいった結果だけです。
実際には、その手前にたくさんの判断があります。なぜその方式を選んだのか、何を試してやめたのか、どこで詰まったのか。これらは完成物を見ても分かりませんし、時間が経つと自分でも忘れます。
何を書くか
- 開発ログ — つくっている途中の話。設計の判断とその理由
- 技術 — 実際に動かして分かったこと。ドキュメントに書いていない挙動や、ハマった罠
- 考えたこと — 方針や価値観の整理
- リリース — 新しいものを公開したときの背景
書く基準
実際に手を動かして確かめたことだけを書きます。 「たぶんこうだろう」は書きません。試していないことは「試していない」と書きます。
うまくいかなかった話も残します。個人開発の記録として、失敗した選択肢が書いてあるほうが後から役に立つからです。