学習ノートをあえて公開する

なぜノートを公開するのか

勉強なら手元のノートで十分なはずです。それでも公開する形にしたのには理由があります。

ひとつは公開を前提にするとごまかしが効かないからです。「なんとなく分かった気」で書いた式は他人の目に触れると思うと途端に書けなくなります。結論式。適用範囲。導出。数値例。この4点が揃わないと1本として成立しないルールにしているのは自分の理解の穴をあぶり出すためです。

もうひとつは答案練習を兼ねられることです。電子応用のII-1は600字1枚で用語を説明する問題が出ます。公開ノートを書くこと自体がそのまま練習になる。だから用語ノートは本文とは別に600字以内の答案例を持つ二層構造にしています。字数はビルド時に自動でチェックされ超過するとそもそも公開できません。

黙って数値を返さない

技術者としてこだわったのは正しくない振る舞いをしないことです。

各ノートには計算機を付けています。ただし適用範囲の外の入力や未入力の状態で中途半端な数値を返さないようにしました。入力欄にデフォルト値も置いていません。サンプル読込ボタンだけです。

もっともらしい数字が勝手に出てくるのは学習ツールとして害だと考えています。式の意味を理解せずに数字だけ眺めても身につきません。むしろ「入力が足りないので計算できない」と表示するほうが学習には有益です。

テストで担保する

計算ロジックはUIから切り離した純関数にしています。公開している関数すべてにテストを書いていて現在74件です。

式が合っているかどうかを自分の気分ではなくテストという外部の判定に委ねる。仕事で検証プロセスに向き合ってきた人間として、ここは譲れませんでした。

間違いが見つかったときもこっそり上書きはしません。版を上げて訂正の履歴を残します。技術文書としての誠実さの問題です。

データの不備でビルドを落とす

記事のメタ情報はzodで検証しています。必須項目が欠けている。用語ノートの答案例が600字を超えている。存在しない記事を参照している。こうした状態ではビルドが通りません。

人間のレビューに頼ると見落とします。機械的に検出できるものは機械に任せる。品質を意志で保とうとしないのが、続けるための条件だと考えています。

続けられる仕組みにする

もうひとつ大事にしたのは追加コストを限界まで下げることです。新しいノートを1本増やすコストをMDXファイル1つに固定しました。必要なら関数1つとテストが加わりますが、それ以上は増えません。

理由は単純で、まとまった時間がないからです。本業をこなしながら細切れの時間で書き続けるには、1本書くたびに仕組みと格闘していては続きません。

続けられない学習法は正しくても意味がない。ここは開発の考え方と同じです。理想的な設計より、実際に運用できる設計を選ぶ。

設計の判断をまとめると

方針	理由
4点セットを必須にする	結論式・適用範囲・導出・数値例が揃わないと理解の穴が残る
デフォルト値を置かない	意味のない数字が出ると学習の妨げになる
純関数として切り出す	UIと分離するとテストが書ける
訂正は版を上げる	上書きすると誤りの記録が消える
ビルドで検証する	人間のレビューは見落とす
追加コストをMDX1本に固定	時間がない前提で設計しないと続かない

公開範囲について

扱うのは公開規格と教科書の範囲だけです。実務で得た情報は例示にも使いません。

試験対策のノートである以上、必要な内容は公開されている教科書と規格の中に全部あります。業務で見たものを持ち出す必要はありません。ここは最初に決めた線です。

おわりに

派手なサイトではありません。試験に出る式を並べて、計算機を付けただけです。

ただ、書くことで受かるという一点に向けて設計を寄せました。理解が曖昧なまま公開できない仕組みにして、続けられる程度に軽くする。この2つが両立していれば、勉強は進むはずだと考えています。

同じ試験に挑む方の役に立てば幸いです。