Skip to content

requirements-design: 外部ツールの優先順位・既定挙動を「調査で確定した事実」に書くときは実測を根拠にする #599

Description

@takemi-ohama

何を見つけたか

devbase PLAN52(devbasex/devbase#162 → PR #163)の要求仕様で、「調査で確定した事実」の表に
「DOCKER_CONTEXT は DOCKER_HOST より優先する」と Docker の文書を根拠に書いた。設計レビューの
round 4 で kiro が逆だと指摘し、手元で確かめると実際に DOCKER_HOST が勝った(Docker 29.4.3)。

$ DOCKER_HOST=tcp://127.0.0.1:1 DOCKER_CONTEXT=desktop-linux docker version
Cannot connect to the Docker daemon at tcp://127.0.0.1:1. Is the docker daemon running?

この 1 行の誤りが設計(反映の仕組み・問い合わせの環境・受け入れ条件)の 4 か所に波及し、
レビュー 2 ラウンド分(round 4 と round 6)の指摘と修正になった。

置き先

NDF の requirements-design に「調査で確定した事実」の欄は無い。 仕様の雛形
(references/spec-template.md)の節は、依頼・目的・前提・対象範囲・用語・受け入れ条件・非機能の条件・
影響・検証手段・前提とする取り決め・境界・未決で、事実と根拠を並べる節を持たない。devbase の要求仕様の
「調査で確定した事実」は、その文書が独自に置いた節である。

そのため、次のどちらに置くかを決める。

案 置き先 中身
手順に足す SKILL.md の手順 3「前提を明示する」 外部ツールの優先順位・既定値・環境変数の効き方は、実測(コマンドと出力)で確かめてから事実として書く。実測できないもの(別ホスト・別 OS)は前提へ置く
雛形に欄を作る references/spec-template.md 「確かめた事実」の節を新設し、事実ごとに根拠(実測のコマンドと出力、または文書と版)の欄を持たせる

どちらの案でも、文書の引用だけで外部ツールの挙動を確定しない。 文書は版でずれ、複数の文書が
矛盾することがある(Docker は「Environment variables」と「docker context use」の説明が食い違う)。

参考

関連

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    area: ndf-skillNDF の Skill 本体enhancementNew feature or requestpriority: medium保守性・設計一貫性など、計画的に対応する

    Type

    No type

    Projects

    No projects

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions