ドキュメントの目次06 / 16

基本のワークフロー06 / 16

説明と根拠を読む

このページの内容

実装の説明では、意図からコードの仕組みを理解し、その説明の根拠を探せます。動作、裏付け資料、まだ判断が必要な問いに注目してください。

段落と局所的な説明を開く

文章をクリックすると編集できます。段落内の文字以外の空白をクリックすると、L1 と表示される段落レベルの説明が開きます。

単語や句に対応する説明もあります。段落にポインターを重ねると短い下線が現れ、クリックすると L2 の局所的な説明を読めます。

リスト、表、コードブロックにも説明を付けられます。リスト全体をまとめて調査し、見出し単独では調査しません。

複数段落の余白ノートを開いたままにできます。各段落は段落レベルか局所的な説明のどちらか一つを表示します。狭い画面ではノートが段落の下に出る場合があります。

三つの項目を読む

項目答える問い注目する内容
実装実装はこの意図にどう対応しているか。動作、手順、境界条件、実装上の選択。
根拠説明を何が裏付けるか。コード参照、テスト、コマンド出力など確認可能な資料。
注意点さらに何を判断すべきか。不足、実装上の選択、リスク、提案。

実装は既定で展開されます。必要に応じて根拠を開きます。注意点がなければその項目は表示されません。

7 日連続の報酬なら、日数の蓄積を説明し、関連関数とテストを引用し、時差をまたぐ移動の扱いに注意を促すことがあります。実際の内容はプロジェクトの調査に依存します。

根拠を調べる

コード参照はシステム既定のアプリで開きます。画像は余白ノートで表示・拡大できます。コマンド出力やコード差分などのラベルは新しいタブを開きます。資料が利用できなくなっている場合は通知します。

各参照が問いに答えるか、テストがどんな条件を扱うか、結果が結論を支えるかを確認します。重要なケースがなければ、段落について質問し、追加調査や検証を依頼します。

特に、次の三つを区別します。

資料確認に役立つこと確認できないこと
実装やテストのコード使われるロジックとテストが定義するケース。テストの存在は実行や合格を意味しない。
過去の実行結果当時の実行内容とその時点の結果。後のコード変更で適用できなくなる場合がある。
今回実行された検証今回の環境と範囲における結果。対象ケースの合格は、未テストのケースの正しさを証明しない。

説明と調査は通常、毎回テスト、ビルド、アプリを動かすのではなく、コードと既存資料を読みます。読むだけでは重要な判断を確定できないとき、必要に応じて事実を検証します。実際に実行した内容から範囲を判断してください。

特定のテストを再実行するなら、チャットで実行と範囲・結果の報告を依頼し、その後で関連段落を再調査します。

意図に含める選択を決める

「現在はローカルストレージを使う」という説明は現状の記述であり、将来もそれを求めるものではありません。維持したい要件は意図に書きます。

ユーザー体験、費用、プライバシー、リスク、将来の判断への影響を考えます。理解した後は、主に次の二通りです。

  • 現状を受け入れ、今後の変更余地を残す:制約にせず、そのまま使う。
  • 将来も維持する必要がある:要件を明記し、導入する制約をレビューする。

例えば今はチェックイン記録のローカル保存を受け入れても、オフライン利用が必須になれば「ネットワークがなくてもチェックインできる」と書き、実装がその動作をどう支えるか調査します。詳細な実装説明を写すより、必要な動作を書く方が通常は維持しやすくなります。

注意点を理解する

注意点は不足、実装上の選択、リスク、提案に分類され、未達の動作と現在の設計選択、検討すべき話題を区別します。

段落右の注意マーカーから関連説明を開けます。数字は個別の問題数ではなく、注意点を含む説明パネル数です。不足がある場合は色が目立ちます。

影響を理解してから、コード修正、検証追加、意図変更、現状維持を選びます。すべてを要件にする必要はありません。マーカーがないことは、現在の説明に注意点がないという意味だけです。

動作の図解を試す

一部の説明には小さな対話型の図解があります。操作、リセット、ソースの確認ができます。

図解はアプリやネットワークにアクセスできない隔離サンドボックス内で動き、操作状態を保存しません。ルールの説明用であり、実際のソフトウェアが従うかはコードと検証の根拠で確認します。

説明が今も適用できるか確認する

以前のテキストは編集前の意図の説明です。古い可能性がありますは調査後に参照・読取ファイルが変わったという意味です。どちらも再調査の理由になります。

余白ノートは読み取り専用です。要件は意図を編集し、説明の確認には調査またはもう一度調査を使います。説明を最新に保つをご覧ください。