In quale tempo grammaticale dovrei scrivere le mie specifiche?


21

Attualmente stiamo scrivendo le specifiche funzionali e tecniche in un formato a due colonne; frase di sintesi e dettagli tecnici. I dettagli si riferiscono spesso ad un'appendice con diagrammi, disegni di layout ecc.

Tuttavia, sto lottando con il tempo in cui scriverlo:

Con il passato come se il lavoro fosse finito, faccio fatica a mostrare le estensioni salienti del lavoro in uscita. Il tempo futuro come in esso deve fare X inizia a suonare come un elenco di cose da fare o il tempo neutro del tempo molto difficile come deve essere fatto o è fatto.

Per aggiungere ulteriore confusione, questa specifica può essere letta da persone che non hanno l'inglese come prima lingua.

Risposte:


12

Ne abbiamo molti nel mio ultimo posto di lavoro.

I responsabili del prodotto hanno scelto di usare il presente per descrivere cosa deve essere fatto , come:

L'utente invia un ordine. Il sistema invia un messaggio di conferma.

Purtroppo la descrizione delle condizioni preliminari è stata fatta anche al tempo presente, come:

L'utente inserisce un articolo nel carrello e specifica la quantità.

Ciò ha causato molta confusione per me poiché non è chiaro cosa sia già e cosa deve ancora venire. Ho provato a farli usare qualsiasi tipo di futuro ma non sono mai cambiati. Personalmente, non ci sono riuscito ad abituarmi in tutti i miei due anni lì. Non ha alcun senso, sembra che qualcuno non abbia padronanza dei tempi delle lingue.


Perciò:

  • Usa un tempo presente per ciò che già esiste

  • Usa un tempo futuro per ciò che deve essere fatto. Impiegare i mondi "dovrebbe", "deve", "volontà".


Il passaggio importante da ricordare è rivisitare le specifiche. Assicurati di aggiornare la formulazione dal futuro al presente al termine.
Ben L,

@BenL: No, è sbagliato. Il tempo viene utilizzato per come fornire un'implementazione corretta, non per indicare lo stato dell'implementazione. Qui, il tempo futuro viene utilizzato per indicare un futuro stato dell'applicazione, non un futuro stato di implementazione. A parte questo, vale la pena notare che l'approccio qui proposto è utilizzato anche dalla maggior parte delle RFC. Vedere RFC 2119 per la discussione dei termini must / richiesto / deve (non), dovrebbe / raccomandato (non) e maggio / facoltativo.
Brian,

5

Il tempo presente mi sembra buono.

  1. Presupposto: Foo è nello stato X
  2. Operazione: questo e quello succede
  3. Postcondizione: Foo è nello stato Y

tutti quelli sono al tempo presente.

O se si tratta di uno "stato del progetto"

  1. Versione 10: ha le funzionalità A, B, C e D

  2. Versione 10.1: contiene miglioramenti ad A. Correzione del bug 1049 in B. Aggiunge una nuova funzione E.




1

Quando creo progetti per software, preferisco il presente, anche se creo i progetti prima che il software esista. Anche dopo che un'applicazione software è stata implementata dal progetto, il progetto è ancora rilevante e documento importante. È possibile che un documento di progettazione possa rimanere rilevante per un periodo di tempo più lungo dopo l'implementazione del software rispetto a prima dell'implementazione.

Utilizzando il nostro sito, riconosci di aver letto e compreso le nostre Informativa sui cookie e Informativa sulla privacy.
Licensed under cc by-sa 3.0 with attribution required.