ITエンジニア/デザイナ向けにオープンソースを毎日紹介

最近、人様の書かれた仕様書をチェックする機会が何度かあったのですが、その多くが非常に分かりづらいものでした。書いているのは日本人ですし、読み手も日本人なのですが確実に齟齬が発生するだろうと分かるものです。

そこで今回は人が理解できる仕様書を書くために最低限注意して欲しい6つのことを紹介します。

主語述語をはっきりさせる

日本語は主語がなくても通じる言語なので、仕様書の中でも度々主語や述語が省略されることがあります。しかしその結果、人(かつどの権限を持った人)が行うことなのか、システムが自動的にやることなのかがはっきりしないことがあります。

誰がいつ、どのタイミングでどうやって実行するのかを明確にする必要があります。その解釈の違いによる実装ミスはとても多いです。

以下はプレミアムのみです。

 

MOONGIFTの関連記事

コメント

  • DevRel
  • Com2