NotionとGitHub、同じ設計判断をどちらに書くか

Notionに次にも使う知見、GitHubの方法に実行手順、変更記録に個別の差分・採用理由・確認結果を残す分担。

NotionとGitHubを使っていると、どちらにも書けることが結構あります。目的、決めた理由、次に直したいこと。全部を両方に置くと、今度は「どっちを直すんだっけ」が仕事になります。

自分は、次の案件でも使う知見はNotion、今回の変更を説明する記録と実行手順はGitHub、という分け方にしています。同じ判断に触れることはあっても、同じ長文を二つの正本にしない。今回は、実際に見直した手順を一件だけ使って、この境界を説明します。

一件の判断を、三つの役割に分ける

今回扱ったのは、「媒体や機能を増やす前に、本当に必要かを比べる」という判断です。

発信先の候補を並べると、それぞれに役割をつけることはできます。でも、全候補の使い道を説明できることと、全部を運用する価値があることは別です。アプリでも、機能ごとの役割を埋めているうちに、そもそも必要かを考える順番が後ろへ回ることがあります。

この判断を、次のように残しました。

置き場所今回、残した内容次に見る理由
Notionの知見ページなぜ必要性を先に比べるのか、どんな場面で使うか、例外は何か別の記事やアプリでも、この考えを使えるか判断する
GitHubのスキル本体目的への寄与、負担、既存手段、追加しない案を比較する手順次の作業で実際に適用する
GitHubの変更記録今回その手順を足した理由、変更点、レビューと確認した範囲この改訂が何を変え、何をまだ確かめていないか追う

GitHubにも「理由」はあります。ただし、こちらは今回の変更を理解するための理由です。Notionでは、別の仕事に持ち込める判断として、条件や反例を育てます。ファイル形式ではなく、後で何のために読むかで分けています。

全文を渡さず、必要な背景と参照を渡す

この件では、知見の入口を実行手順から参照できる形にし、方法の版も更新しました。Notion側には、どの改訂へ反映したかを戻しています。

次の作業に渡す情報は、たとえばこうなります。以下は、今回の判断を短く言い換えた例です。

使う判断:接点や機能へ役割を配る前に、必要性を比べる
使う場面:複数の公開先や機能を選ぶとき
見直す条件:学習や探索では、作ること自体にも価値がある
適用する方法:コンセプト設計の手順 0.2
今回確認したこと:記事・アプリ等の合成依頼から回答案を作れること
未確認:実際の読者への効果、確認負担が減ること

これだけであらゆる背景が伝わるとは考えていません。手順の意味が曖昧なら、元の知見や変更記録へ戻る。参照先を読めていなければ、その状態も分かるようにする。参照したつもりで先へ進む方が怖いです。

二つに分けなくてよい場合もある

一度だけの文言修正なら、変更履歴に理由があれば足りるかもしれません。GitHub上の設計メモだけで次の仕事にも使えているなら、Notionへ移すための作業を増やす必要もありません。

自分が分けたいのは、複数の制作で育てたい知見と、個別の変更を確かめる材料がある場合です。NotionとGitHubを両方使うことが、目的ではありません。

まず一件の判断について、「次の自分は、何を決めるためにこれを読むか」を書いてみる。その答えが、置き場所を決める手掛かりになります。記録の収納に凝りすぎて、作る方が止まらないくらいに。

全体の考え方は、AIとの開発で残したいのは、正解より「その判断をした理由」にもまとめています。

コメントを残す

メールアドレスが公開されることはありません。 ※ が付いている欄は必須項目です

CAPTCHA