Em que tempo gramatical devo escrever minhas especificações?

21

No momento, estamos escrevendo especificações funcionais e técnicas em um formato de duas colunas; frase sumária e detalhes técnicos. Os detalhes geralmente se referem a um apêndice com diagramas, desenhos de layout etc.

No entanto, estou lutando com que tensão para escrevê-lo:

No passado, como se o trabalho estivesse terminado, luto para mostrar extensões de destaque do trabalho de saída. O tempo futuro, como ele precisa fazer, X começa a soar como uma lista de tarefas ou o Tense neutral é muito difícil, já que será feito ou será feito.

Para adicionar mais confusão, essa especificação pode ser lida por pessoas que não têm o inglês como primeiro idioma.

documentation specifications writing John
fonte

Respostas:

12

Temos muito disso no meu último local de trabalho.

Os gerentes de produto optaram por usar o tempo presente para descrever o que deve ser feito , como:

O usuário envia um pedido. O sistema envia uma mensagem de confirmação.

Infelizmente, a descrição das pré-condições também foi feita no tempo presente, como:

O usuário coloca um item no carrinho de compras e especifica a quantidade.

Isso me causou muita confusão, pois não está claro o que já é e o que ainda está por vir. Eu tentei fazê-los usar qualquer tipo de tempo futuro, mas eles nunca tiveram que mudar. Pessoalmente, eu não consegui me acostumar com isso em todos os meus dois anos lá. Simplesmente não faz sentido, parece que alguém não tem domínio dos tempos linguísticos.

Assim sendo:

  • Use um tempo presente para o que já existe

  • Use um tempo futuro para o que deve ser feito. Empregue os mundos "deveria", "deve", "irá".


fonte
O passo importante a lembrar é revisitar as especificações. Atualize a redação do futuro para o presente quando terminar.
Ben L
@ BenL: Não, isso está errado. O tempo é usado para fornecer uma implementação correta, não para indicar o status da implementação. Aqui, o tempo futuro é usado para indicar um estado futuro do aplicativo, não um estado futuro da implementação. Como um aparte, vale a pena notar que a abordagem defendida aqui também é usada pela maioria das RFCs. Consulte a RFC 2119 para discussão dos termos must / required / should (not), should / recommended (not) e may / optional.
30715 Brian
5

O tempo presente parece bom para mim.

  1. Pré-condição: Foo está no estado X
  2. Operação: isso e aquilo acontecem
  3. Pós-condição: Foo está no estado Y

todos esses estão no tempo presente.

Ou se é um "estado do projeto"

  1. Versão 10: possui os recursos A, B, C e D

  2. Versão 10.1: contém aprimoramento para A. Corrige o bug 1049 em B. Adiciona o novo recurso E.

CashCow
fonte
2

especificações são instruções. escreva-os no tempo presente. como isso.

Steven A. Lowe
fonte
1

Quando crio designs para software, sou a favor do tempo presente, mesmo que os crie antes que o software exista. Mesmo depois que um aplicativo de software é implementado a partir do design, o design ainda é um documento relevante e importante. É bem possível que um documento de design permaneça relevante por um período mais longo após a implementação do software do que antes da implementação.

Dan Stevens
fonte