In quale grammatica dovrei scrivere le mie specifiche?

20

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

Tuttavia, sto lottando con il tempo per scriverlo:

Con il passato come se il lavoro fosse finito, fatico a mostrare estensioni evidenti del lavoro in uscita. Il tempo futuro come in quello che ha bisogno di fare X inizia a suonare come una lista delle cose da fare o Tense neutral molto difficile dato che o sta per essere fatto o è fatto.

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

    
posta John 18.02.2011 - 15:50
fonte

5 risposte

12

Ne abbiamo un sacco nel mio ultimo posto di lavoro.

I product manager hanno scelto di utilizzare il tempo presente per descrivere cosa deve essere fatto , come:

The user sends an order. The system sends a confirmation message.

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

The user puts an item into the shopping cart and specifies the quantity.

Questo ha causato molta confusione, dal momento che non è chiaro cosa sia già e cosa debba ancora arrivare. Ho provato a farli usare qualsiasi tipo di tempo futuro, ma non hanno mai potuto cambiare. Personalmente, non potevo abituarmici in tutti i miei due anni lì. Non ha alcun senso, sembra che qualcuno non abbia una padronanza dei tempi verbali.

Quindi:

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

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

risposta data 18.02.2011 - 16:02
fonte
5

Il tempo presente mi sembra buono.

  1. Precondizione: Foo si trova nello stato X
  2. Operazione: questo e quello che succede
  3. Postcondition: Foo è nello stato Y

tutti questi sono al tempo presente

O se è uno "stato di progetto"

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

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

risposta data 18.02.2011 - 15:58
fonte
3

Potresti voler sapere qual è la pratica per scrivere RFC.

Questa è RFC 2119: parole chiave per l'uso nelle RFC per indicare i livelli di fabbisogno .

    
risposta data 18.02.2011 - 16:20
fonte
2

le specifiche sono istruzioni. scrivili al tempo presente. così.

    
risposta data 18.02.2011 - 17:40
fonte
1

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

    
risposta data 02.08.2013 - 17:02
fonte

Leggi altre domande sui tag