全ての仕様にURLを付けたらどうか?

tracの障害チケットに目を通していたら、該当する仕様としてこんな記載が載っていた。

○×仕様書の□ページの上から△行目に記載されている〜について...

大きな偏見だと思うけど、Word等で記載されたダラダラとした文章が並ぶ仕様書を見ると「これは要注意」という黄色いランプが点滅してしまう。複数のセンテンスから成る文章全体で一つの仕様が構成されるという趣旨は分かるけれど、そもそも「どこからどこまでが一つの完結した仕様」なのか分からないし、他の資料との紐付けがやりにくい。例えば、上記のような書き方では、資料に追記・削除が行われたらレイアウトが崩れ、意味を成さない記述になってしまうので、後から見た人は関連する箇所を辿れないことになる。

仕様書は小説でもエッセイでもないのだから凝った表現は不要であり、もっと形式的な書き方に力を注ぐべきではないかと思う。だから仕様書の記載では章立てを確実に行い、個々の説明も番号付きの箇条書きを多用することが多い。これなら下記のメリットがある。

  • 資料の追記・削除が行われても仕様を確実にトラッキング可能
  • 仕様をピンポイントで特定可能
  • 資料の書き方がある程度形式化されるので、誰でも同レベルの内容を記載可能

これをさらに一歩進めると、一つの仕様(文章)に対して一つのURLを付ける事を考えるようになる。以前に「仕様書をTracのWikiに記載する」で書いたように、仕様をwikiに書くと少なくともセクション単位(章見出し等)ではURLでの指定が可能だ。これが個々の文章まで自動的にURLリンクが付加されればかなり役立つと思う。指定方法がURLで統一されるので「○章×節△項□番」のような回りくどい説明が不要になり、トラッキングがずっと容易になるのではないだろうか?

もっとも、このリンクに対して本当に該当コードやテスト仕様書が存在するか否か、相互リンクで検証することは次のステップとして必要になってくるだろう。今回のアイデアは、まず仕様を辿るための手がかりとしての位置付けだ。