仕様をどの文法形で書くべきですか？
現在、機能および技術仕様を2列の形式で作成しています。要約文と技術的詳細。詳細は、図やレイアウト設計などの付録を参照することがよくあります。
しかし、私はそれをどの時制で書くかと苦労しています：
仕事が終わったかのように過去形で、私は既存の仕事の拡張を強調表示するのに苦労しています。 Xを行う必要があるような将来の時制は、XがTo Doリストのように聞こえ始めます。
さらに混乱を増すために、この仕様は英語を第一言語として持っていない人々によって読まれるかもしれません。
私の最後の仕事場にはそれがたくさんあります。
製品マネージャーは、現在時制を使用して何をしなければならないかを記述することを選択しました。
ユーザーが注文を送信します。システムは確認メッセージを送信します。
残念ながら、前提条件の説明は次のように現在形でも行われました。
ユーザーはアイテムをショッピングカートに入れ、数量を指定します。
すでに何が来て何が来ていないのかはっきりしないので、これは私に多くの混乱を引き起こしました。私は彼らに将来のいかなる種類の時制を使用するように試みましたが、それらは決して変更する必要がありませんでした。個人的には、ここ2年間は慣れませんでした。それは意味をなさないだけで、誰かが言語時制を習得していないように聞こえます。
したがって：
すでに存在するものに現在形を使用する
何をしなければならないかについて未来時制を使用します。 「すべき」、「しなければならない」、「意志」の世界を採用する。
現在形は私には良いようです。
- 前提条件：Fooは状態Xです
- 操作：これとそれが起こります
- 事後条件：Fooの状態はY
それらのすべては現在時制です。
または「プロジェクトの状態」の場合
バージョン10：機能A、B、CおよびD
バージョン10.1には、Aの改善が含まれています。Bのバグ1049が修正されています。新機能Eが追加されています。
RFCを作成するための慣行を知りたい場合があります。
仕様は指示です。現在時制で書いてください。このような。
ソフトウェアのデザインを作成するときは、ソフトウェアが存在する前にデザインを作成したとしても、現在形を好みます。ソフトウェアアプリケーションが設計から実装された後でも、設計は依然として重要で重要な文書です。ソフトウェアが実装される前よりも、ソフトウェアが実装された後の方が、設計ドキュメントの関連性が高い可能性があります。