Dans quel temps grammatical dois-je écrire mes spécifications?

21

Nous rédigeons actuellement des spécifications fonctionnelles et techniques dans un format à deux colonnes; phrase sommaire et détail technique. Les détails se réfèrent souvent à une annexe avec des diagrammes, des schémas de configuration, etc.

Cependant, je me bats avec quel temps l'écrire:

Au passé, comme si le travail était terminé, j'ai du mal à montrer les extensions de travail en cours. Futur tendu comme il doit le faire X commence à ressembler à une liste de choses à faire ou à un neutre tendu très dur car cela va être fait ou est fait.

Pour ajouter à la confusion, cette spécification peut être lue par des personnes qui n'ont pas l'anglais comme première langue.

documentation specifications writing John
la source

Réponses:

12

Nous en avons beaucoup à mon dernier lieu de travail.

Les chefs de produit ont choisi d'utiliser le présent pour décrire ce qui doit être fait , comme:

L'utilisateur envoie une commande. Le système envoie un message de confirmation.

Malheureusement, la description des conditions préalables a également été faite au présent, comme:

L'utilisateur place un article dans le panier et précise la quantité.

Cela a causé beaucoup de confusion pour moi car on ne sait pas ce qui est déjà et ce qui est à venir. J'ai essayé de leur faire utiliser n'importe quel futur, mais ils n'ont jamais pu changer. Personnellement, je n'ai pas pu m'y habituer pendant toutes mes deux années là-bas. Cela n'a tout simplement aucun sens, on dirait que quelqu'un n'a pas une maîtrise des temps des langues.

Donc:

  • Utilisez un temps présent pour ce qui existe déjà

  • Utilisez un futur pour ce qui doit être fait. Employer les mondes «devrait», «doit», «veut».


la source
L'étape importante à retenir est de revoir la spécification. Assurez-vous de mettre à jour le libellé du futur au présent lorsque cela sera fait.
Ben L
@BenL: Non, c'est faux. Le temps est utilisé pour savoir comment fournir une implémentation correcte, et non pour indiquer l'état de l'implémentation. Ici, le futur est utilisé pour indiquer un futur état d'application, et non un futur état d'implémentation. En passant, il convient de noter que l'approche préconisée ici est également utilisée par la plupart des RFC. Voir RFC 2119 pour une discussion des termes doit / requis / doit (pas), devrait / recommandé (pas), et peut / facultatif.
Brian
5

Le présent me semble bon.

  1. Condition préalable: Foo est dans l'état X
  2. Opération: ceci et cela se produisent
  3. Postcondition: Foo est dans l'état Y

tous ces éléments sont au présent.

Ou s'il s'agit d'un "état d'avancement du projet"

  1. Version 10: a les fonctionnalités A, B, C et D

  2. Version 10.1: contient des améliorations pour A. Corrige le bogue 1049 dans B. Ajoute une nouvelle fonctionnalité E.

Vache à lait
la source
2

les spécifications sont des instructions. écrivez-les au présent. comme ça.

Steven A. Lowe
la source
1

Lorsque je crée des designs pour un logiciel, je préfère le présent, même si je crée les designs avant que le logiciel existe. Même après la mise en œuvre d'une application logicielle à partir de la conception, celle-ci reste un document pertinent et important. Il est tout à fait possible qu'un document de conception puisse rester pertinent plus longtemps après la mise en œuvre du logiciel qu'avant sa mise en œuvre.

Dan Stevens
la source