← 活動記録一覧

FACTUAL ACTIVITY RECORD · 実際の作業をもとにした活動記録

system仕様を責務別の正本へ再編する

現在のbehaviorとinterfaceを12の仕様へ分け、作業履歴と分離する

対象期間:

目的

公開後のsystemを改善するには、初期構築の要件や試行錯誤を現行仕様と混同せず、責務ごとの現在のbehaviorを確認できる文書構造が必要だった。

実装

単一の統合仕様を目次と12の責務別仕様へ再編した。各仕様には現在のbehavior、interface、状態、failure、security、運用だけを残し、改善課題は目次の問題管理、現在使わない技術は将来を禁止しない非対象へ集約した。初期構築由来の名称も機能名へ置き換えた。

AGENTS.md — system仕様書の責務境界から非ハーネスlocatorだけを一般化した一次抜粋公開境界に合わせた抜粋
- 「仕様書」は「要件書」ではなく、現在の実装内容を可視化した文書です。仕様書の記載を絶対要件と捉え、改善すべき実装を「要件だから変更しない」と判断してはなりません。改善すべき点は適切に改善し、変更後の実装に合わせて所有する個別仕様も同時に更新してください。
- 実装、設定、運用手順を変更する前に、変更対象を所有する個別仕様を特定し、その仕様と関連する実装上の正本を確認してください。
目次をrouting正本とし、現在のbehaviorを責務ごとの個別仕様へ分配した。

図を描画しています…

確認したこと

確認結果

全体検証、267 database assertion、fixture再投入、Control Center検証、相対linkと旧表現の横断検査が通った。

production behaviorと外部resourceは変更せず、仕様の所有境界だけを対象へ反映した。

完了とした根拠

現行実装を責務別に参照でき、作業履歴や将来案と混同しない仕様体系を検証できたことをもって完了とした。