Holarch

Guia · Requisitos

Como escrever bons requisitos de sistema: exemplos e checklist

Ouvir este guia 26 min

Um bom requisito diz uma única coisa que o sistema deve fazer ou ser, em palavras que dois engenheiros leem da mesma forma, com um valor que um teste ou uma análise pode checar. Este guia trata de necessidades versus requisitos, das partes de uma declaração de requisito, das características de qualidade da ISO/IEC/IEEE 29148 e do INCOSE Guide to Writing Requirements, de uma checklist com exemplos de antes e depois, de métodos de verificação e critérios de aceitação, de valores TBD e TBR e de tipos de requisito, tudo aplicado a uma única especificação de CubeSat.

Nesta página
  1. Por que a redação de um requisito importa
  2. Necessidades das partes interessadas versus requisitos
  3. A anatomia de um requisito
    1. A declaração
    2. Os atributos
  4. Características de qualidade de um bom requisito
  5. A checklist: regras com exemplos de antes e depois
  6. Escreva o método de verificação e os critérios de aceitação junto com o requisito
  7. Tratando valores TBD e TBR
  8. Tipos de requisito
  9. Exemplo prático: revisando a especificação do EO-1
    1. Constatações menores
    2. Três reescritas
  10. Erros comuns
  11. Experimente no Holarch
  12. Baixe a checklist
  13. Perguntas sobre a redação de requisitos
    1. Shall, must ou will?
    2. Quantos requisitos um sistema deve ter?
    3. User stories são requisitos?
    4. Uma ferramenta consegue checar a qualidade dos requisitos?
  14. Para onde ir a seguir

Por que a redação de um requisito importa

Um requisito é um contrato entre quem pede um sistema e quem o constrói. Tudo o que vem depois o lê: o projetista dimensiona um componente com base nele, o engenheiro de testes escreve um critério de aprovação a partir dele, o comitê de mudanças pesa uma mudança em relação a ele, e o cliente aceita o sistema por ele. Cada um deles lê a mesma frase, geralmente sem o autor presente. Se a frase puder ser lida de duas maneiras, ela será, e a diferença aparece tarde: em um teste que é “aprovado” segundo um critério que ninguém acordou, ou na aceitação, quando o cliente queria dizer outra coisa.

Uma redação ruim também quebra o resto do modelo. Um requisito sem valor não pode ser alocado a um componente, porque ninguém consegue dizer se o componente o atende. Ele não pode ser verificado, então aparece como uma lacuna de cobertura na rastreabilidade e na matriz de verificação. E, quando ele muda, ninguém consegue dizer se o projeto vinculado continua válido. Escrever bem os requisitos é o trabalho de qualidade mais barato de um projeto: uma hora em uma frase no início poupa uma campanha de testes no fim.

O guia usa um exemplo contínuo, o EO-1, um CubeSat 6U fictício que fotografa terras agrícolas em quatro bandas espectrais. Sua especificação, SRS-001 EO-1 System Requirements Specification, tem 32 requisitos, a maioria deles sólidos e três fracos de propósito. É o mesmo modelo do projeto de exemplo de MBSE de ponta a ponta. As necessidades das partes interessadas N1 a N3 citadas aqui são as que o guia de rastreabilidade acrescenta ao modelo.

Necessidades das partes interessadas versus requisitos

A redação de requisitos começa um passo antes, com as necessidades. Uma necessidade da parte interessada é o que um usuário, operador, cliente ou regulador espera, nos seus próprios termos. Um requisito é a declaração de engenharia em relação à qual o sistema é projetado e verificado. A ISO/IEC/IEEE 15288 mantém os dois separados em processos técnicos distintos: definição de necessidades e requisitos das partes interessadas (6.4.2) e definição de requisitos do sistema (6.4.3). O Needs and Requirements Manual do INCOSE faz a mesma divisão e trata as necessidades como itens por si mesmos, não como rascunhos de requisitos.

Exemplo do EO-1Checado por
Necessidade (N2 Twice-Weekly Revisit)Os clientes agrícolas precisam de imagens recentes dos seus campos pelo menos duas vezes por semana na estação de cultivo.Validação: os clientes obtêm do sistema entregue o que precisam?
Requisito (1.6 Revisit Time)The mission shall revisit each target region within 72 hours.Verificação: o sistema atende à declaração, por teste, análise, inspeção ou demonstração?

A diferença aparece em como cada um é checado. Um requisito é verificado: o sistema é medido em relação à declaração. Uma necessidade é validada: alguém confirma que o sistema, no uso pretendido, faz o que a parte interessada queria. Um sistema pode passar em todas as verificações e ainda assim falhar na validação, se os requisitos não captaram o essencial; o guia de verificação versus validação trata dessa lacuna. Para a redação, a consequência prática é simples: escreva primeiro a necessidade, depois escreva requisitos que a satisfariam se cumpridos, e vincule cada requisito de volta à necessidade a que ele responde.

A tradução raramente é de um para um. N2 se torna 1.6 Revisit Time, que é então decomposto em 1.6.1 Ground Track Repeat (3 dias) e 1.6.2 Off-Nadir Imaging (25 graus). Alguns requisitos não respondem diretamente a nenhuma necessidade: 3.1 Orbit Average Power é derivado de 1.5 Daily Collection Volume, porque a carga de imageamento define a potência que os painéis precisam fornecer. Nenhum cliente pediu 30 W, mas o imageamento que eles pediram não acontece sem isso.

A anatomia de um requisito

Um requisito é mais do que sua frase. A frase traz a obrigação; um conjunto de atributos em volta dela traz os motivos, o plano para comprová-la e o controle administrativo. As duas metades fazem parte de escrevê-lo.

A declaração

A maioria das boas declarações de requisito segue um padrão. A ISO/IEC/IEEE 29148 (5.2.4) o descreve como um sujeito, uma ação, um objeto e restrições sobre a ação, com uma condição opcional na frente; o Guide to Writing Requirements do INCOSE recomenda a mesma ordem e modelos acordados para cada tipo de requisito.

ParteO que dizEO-1 4.3 Fault Detection
Condição (opcional)Quando, em qual modo ou estado, o requisito se aplica“…of undervoltage detection” (o evento que dispara)
SujeitoO sistema ou elemento que precisa cumprir, nomeado com exatidão“The C&DH”
Verbo modalA força da obrigação“shall”
AçãoO que o sujeito faz ou é, como verbo na voz ativa“enter”
ObjetoA que a ação se aplica“safe mode”
Desempenho ou restriçãoO valor mensurável, com unidade e sentido do limite“within 10 seconds”

Juntando tudo: “The C&DH shall enter safe mode within 10 seconds of undervoltage detection.” A ordem pode mudar (“When undervoltage is detected, the C&DH shall…” coloca a condição primeiro, como nos modelos EARS que muitas equipes usam), mas cada parte deve estar presente ou ausente de propósito.

Três palavras carregam a maior parte do peso. Shall marca um requisito obrigatório; will declara um fato ou uma intenção sobre algo fora do sistema; should declara uma meta que não é verificada. Seja qual for a convenção do projeto, defina-a uma vez na especificação e siga-a. O EO-1 1.1 Reference Orbit (“The mission assumes a 500 km sun-synchronous orbit…”) está corretamente escrito como premissa, não como requisito: é o contexto para os requisitos que dependem dele, e o modelo o guarda como uma declaração que não recebe nota nem é verificada.

Os atributos

Este é o 3.1 Orbit Average Power como o modelo do EO-1 o registra, após a mudança pós-PDR de 28 W para 30 W:

Atributo3.1 Orbit Average PowerPor que está ali
Identificador e nome3.1 Orbit Average PowerUma referência estável para vínculos, revisões e solicitações de mudança
DeclaraçãoThe solar arrays shall generate at least 30 W orbit-average power at end of life.A própria obrigação
JustificativaOrbit-average load grew to 26 W after PDR; 30 W keeps 15% margin.Permite que um leitor posterior avalie uma mudança sem o autor
Fonte e paiDerived (systems analysis); derivado de 1.5 Daily Collection VolumeRastreabilidade para trás: por que o requisito existe
Método e nível de verificaçãoTest, no nível de subsistemaO plano para comprová-lo, decidido durante a redação
Critérios de sucessoEnd-of-life orbit-average power predicted from measured peak power.Qual resultado conta como cumprido
Responsável, prioridade, criticidadePower Engineer; High; HighQuem responde por ele e o quanto ele importa
StatusIn Review (estava Approved; seu texto mudou após a aprovação)Em que ponto do processo de acordo ele está
TBD/TBRNenhumSe um valor ainda está em aberto

A ISO/IEC/IEEE 29148 (5.2.8) lista atributos desse tipo, e o guia do INCOSE acrescenta outros; um projeto escolhe os que vai de fato manter. A justificativa é a mais pulada e a que mais faz falta depois. Sem “carga de 26 W, margem de 15%”, a próxima pessoa que vir o 3.1 não consegue dizer se 30 W é um limite físico rígido, um número do cliente ou uma escolha de margem, e portanto não consegue dizer o que uma mudança na carga significa para ele.

Características de qualidade de um bom requisito

As regras de estilo são mais fáceis de aplicar quando você sabe o que elas protegem. A ISO/IEC/IEEE 29148 (5.2.5) nomeia nove características de um requisito individual, e o Guide to Writing Requirements do INCOSE usa as mesmas nove como C1 a C9, cada uma com uma definição curta e as regras que a sustentam. A tabela apresenta cada uma como uma pergunta que um revisor pode fazer.

CaracterísticaPergunta a fazerExemplo do EO-1
NecessárioSe fosse excluído, algo de que as partes interessadas precisam se perderia? Ele não é uma duplicata?O 3.1 é necessário: sem ele, nada dimensiona os painéis para a carga de imageamento.
ApropriadoEle está escrito no nível certo, sem fixar uma escolha de projeto que o nível abaixo deveria fazer?O 3.1 define um nível de potência para os painéis, não um tipo de célula ou um número de painéis.
InequívocoEle pode ser lido de uma única maneira?O 6.4 “user friendly” falha: dois revisores vão discordar sobre se ele é cumprido.
CompletoEle diz tudo o que é necessário, sem condição ou valor faltando?O 3.5 “warm enough (TBD)” falha: o valor está faltando.
SingularEle declara uma única obrigação?O 2.5 falha: ele pede para se recuperar e para retomar o imageamento, unidos por “and”.
ViávelEle pode ser cumprido dentro das restrições conhecidas de tecnologia, custo e prazo?O 3.1 a 30 W está em dúvida: os painéis, como projetados, dão cerca de 28 W de média por órbita.
VerificávelUm teste, análise, inspeção ou demonstração consegue mostrar que ele é cumprido?O 2.5 “quickly” falha; “within 6 hours” passa.
CorretoEle declara a necessidade real da sua fonte, com o valor certo?O 1.2, com distância de amostragem no solo de 4,5 m, expressa corretamente os mapas no nível de talhão de N3, com margem.
ConformeEle segue os modelos e o vocabulário acordados do projeto?Cada requisito do EO-1 usa “shall”, um sujeito nomeado e unidades do SI.

Um conjunto de requisitos tem características próprias que nenhuma declaração isolada consegue mostrar. A ISO/IEC/IEEE 29148 (5.2.6) lista o conjunto como completo, consistente, viável como um todo, compreensível e passível de validação; o guia do INCOSE acrescenta correto como C15 e numera as características do conjunto de C10 a C15.

  • Completo: o conjunto cobre as necessidades. O EO-1 declara o que acontece em uma subtensão (4.3), mas seu único requisito de recuperação do modo de segurança é o 2.5, que não é verificável como está escrito, então a recuperação fica, na prática, sem especificação.
  • Consistente: nenhum par de requisitos entra em conflito, e termos e unidades são usados da mesma forma. O 1.5 pede 3,2 GB de dados de imagem por dia e o 5.4, 3 GB recebidos em solo; eles só concordam porque a justificativa do 5.4 diz “after compression”. Sem a justificativa, parecem um conflito.
  • Viável: os requisitos podem ser cumpridos juntos. Cada requisito de potência pode ser viável sozinho, enquanto 30 W de média por órbita, a área dos painéis e o orçamento de massa juntos podem não ser.
  • Compreensível: um leitor consegue entender o que se espera do sistema e como os requisitos se relacionam, o que depende tanto de estrutura, numeração e rastreabilidade quanto de redação.
  • Passível de validação: é possível mostrar que o conjunto leva a um sistema que atende às necessidades, e é por isso que cada requisito de nível mais alto se vincula de volta a uma necessidade.

A checklist: regras com exemplos de antes e depois

As características se tornam utilizáveis por meio de regras concretas de redação. O Guide to Writing Requirements do INCOSE as numera (R1, R2 e assim por diante); o Systems Engineering Handbook da NASA (Apêndice C) tem uma checklist mais curta na mesma linha. A tabela reúne as regras que pegam a maioria dos problemas na prática, com um exemplo da especificação do EO-1 para cada uma. “Antes” é o texto como está na demonstração; “Depois” é uma reescrita. Valores marcados como ilustrativos mostram a forma, não resultados de análises do EO-1.

RegraPergunta a fazerAntes (EO-1)Depois
Uma obrigação por declaraçãoExatamente um “shall”, sem “and”, “or” ou “and/or” unindo duas exigências?2.5: “The spacecraft should recover from safe mode quickly and resume imaging as appropriate”“The spacecraft shall resume imaging within 6 hours of a safe mode entry.” Outras etapas de recuperação que importem ganham requisitos próprios.
Redação obrigatória“Shall” para um requisito obrigatório, e não “should”, “will” ou “may”?2.5: “should recover”“shall resume”
Valor mensurável com unidadeToda palavra de desempenho tem um número e uma unidade?2.5: “quickly”“within 6 hours of a safe mode entry”
Sentido do limite declaradoFica claro se o valor é um mínimo ou um máximo?1.6.2: “image targets up to 25 degrees off nadir”“image targets at off-nadir angles from 0 to 25 degrees” (uma faixa de capacidade, não um teto de apontamento)
Sem cláusulas de escapeAlgo fica a critério do fornecedor (“as appropriate”, “if possible”, “where practical”)?2.5: “as appropriate”Removido; a condição que importa é declarada
Sem termos vagos ou subjetivosDois revisores poderiam discordar sobre se ele é cumprido (“user friendly”, “easy”, “adequate”, “enough”)?6.4: “The operator interface shall be user friendly and/or easy to use.”“The operator interface shall let a trained operator book a ground station contact in no more than 5 minutes.” (ilustrativo; um requisito por tarefa que importa)
Substantivos explícitos, sem pronomesTodo “it”, “its” ou “this” tem exatamente um referente possível?1.6.1: “The reference orbit shall repeat its ground track every 3 days.”“The reference orbit shall repeat the ground track every 3 days.” O pronome é inofensivo aqui, mas em uma frase mais longa é a primeira coisa a se desviar.
Condições declaradasEle diz quando o valor se aplica: fase de vida, modo, ambiente?“The solar arrays shall generate 30 W.”“…at least 30 W orbit-average power at end of life.”
Valores definidos, ou TBDs acompanhadosTodo valor em aberto é acompanhado com um responsável e um prazo, e não apenas escrito no texto?3.5: “The thermal design shall keep the battery warm enough (TBD).”“The thermal design shall keep the battery cell temperature at or above 0 °C while charging.” (ilustrativo; até a análise térmica defini-lo, o atributo TBD nomeia o Thermal Engineer e um prazo)
Sem motivos ou notas na declaraçãoExpressões de finalidade (“so that”, “in order to”) e notas entre parênteses foram movidas para a justificativa?3.5: “(TBD)”Declaração sem parênteses; o motivo na Justificativa
O quê, não comoEle declara a necessidade em vez de impor uma solução que o nível abaixo deveria escolher?“The thermal design shall keep the battery warm by means of a 2 W film heater.” (ilustrativo)A reescrita do 3.5 acima: um limite de temperatura, com o aquecedor deixado para o projeto térmico
Positivo e alcançávelEle evita “not”, “never”, “always”, “100%” onde se pretende um limite mensurável?“The C&DH shall never lose a stored command.” (ilustrativo)“The C&DH shall execute each stored command within 1 second of the scheduled time.” (o 4.2 como está escrito)
Justificativa registradaEle diz por que o valor foi escolhido?O 3.1 sem justificativaJustificativa: “Orbit-average load grew to 26 W after PDR; 30 W keeps 15% margin.”
Método e critérios de verificaçãoO método foi escolhido e o critério de aprovação foi derivado da declaração?3.1: método Test; o TC-06 espera potência de pico ≥ 72 WCritério de aprovação derivado pelo orçamento de potência: cerca de 80,6 W de pico para 30 W de média por órbita (veja a próxima seção)
Rastreável para cimaVinculado a uma necessidade, a um pai ou a um requisito de origem?O 3.1 sem vínculo a montanteO 3.1 derivado de 1.5 Daily Collection Volume
ÚnicoAlgum outro requisito diz a mesma coisa com outras palavras?Um segundo “The battery shall store 77 Wh” na seção térmica (ilustrativo)Um único requisito, 3.2 Battery Capacity, referenciado onde necessário

Uma checklist é uma ferramenta do revisor, não um modelo de redação. Leia cada requisito uma vez contra a lista inteira, em vez de caçar uma regra de cada vez, e registre a constatação com a regra que ela viola, para que o autor saiba o que mudar. As regras também têm falsos positivos. Uma checagem por lista de palavras marca “every” no 1.6.1 como quantificador universal, mas “every 3 days” é um período, não uma afirmação sobre todos os casos; um revisor decide.

Escreva o método de verificação e os critérios de aceitação junto com o requisito

A característica de ser verificável é mais fácil de checar no momento em que o requisito é escrito: se o autor não consegue dizer como se mostraria que ele é cumprido, ele não está pronto. Registre duas coisas com cada requisito.

  • Método de verificação: teste, análise, inspeção ou demonstração, e o nível de montagem em que é feito (componente, subsistema, sistema). O EO-1 tem os quatro: o 3.1 é verificado por teste, o 1.5 Daily Collection Volume por análise, o 3.4 Bus Regulation por inspeção e o 6.1 Contact Scheduling por demonstração. O guia da RVTM explica como escolher entre eles.
  • Critérios de sucesso (critérios de aceitação): o resultado observável que conta como cumprido, declarado de forma que o teste ou a análise possa ser escrito a partir dele. Para o 3.2 Battery Capacity: “Measured capacity of at least 77 Wh at C/2 and 20 °C.” Para o 6.2 Image Delivery: “Products on the portal within 6 h for 95% of passes in rehearsal.”

Escrever os critérios ao lado da declaração pega uma classe de erro que, de outra forma, só é encontrada no fim. O 3.1 do EO-1 é verificado pelo TC-06 Solar Array Power Test, que mede a potência de pico em um simulador solar e é aprovado com 72 W ou mais. O requisito, porém, trata de potência média por órbita, e o modelo converte uma na outra com a fração iluminada (0,62) e a eficiência do caminho de potência (0,6). Um pico de 72 W dá 72 × 0,62 × 0,6 = 26,8 W de média por órbita, abaixo dos 28 W originais, que dirá dos 30 W atuais. O limite do teste não foi derivado do requisito. O TC-06 mediu 75,1 W e foi “aprovado”, mas 75,1 W correspondem a 27,9 W, abaixo dos dois valores. Se o critério tivesse sido escrito a partir da declaração, ele indicaria cerca de 30 / (0,62 × 0,6) = 80,6 W de pico, e a insuficiência ficaria visível no primeiro teste. O guia de análise de impacto de mudanças acompanha a mesma constatação ao longo da mudança de 28 W para 30 W.

A lição se generaliza: um critério de aprovação deve ser rastreável até o valor do requisito por uma conta que alguém possa checar, e a conta pertence à justificativa ou ao plano de verificação, não à memória de um engenheiro.

Tratando valores TBD e TBR

No início de um projeto, alguns valores ainda não são conhecidos. Deixar o requisito de fora esconde a lacuna; inventar um número esconde a incerteza. A prática usual é escrever o requisito com um marcador provisório e acompanhar esse marcador como um item em aberto.

  • TBD (to be determined, a determinar): ainda sem valor. “The thermal design shall keep the battery cell temperature at or above TBD °C while charging.”
  • TBR (to be reviewed, a revisar, às vezes “to be resolved”): o melhor valor atual, ainda não confirmado. “…within 60 seconds” com 60 marcado como TBR.

Prefira um TBR com estimativa a um TBD vazio sempre que houver alguma base para um número: os projetistas conseguem trabalhar com uma estimativa, e um valor que depois muda é uma mudança, que a rastreabilidade acompanhará. Cada item em aberto precisa de três coisas, ou não está sendo gerenciado:

  1. Um responsável, a pessoa que vai encerrá-lo.
  2. Um prazo ou marco, normalmente antes das decisões de projeto que dependem dele.
  3. Um plano de encerramento: a análise, o teste ou a decisão que vai definir o valor.

A especificação do EO-1 tem três itens em aberto. O 3.5 Battery Thermal Control é um TBD do Thermal Engineer e já está atrasado. O 2.4 Target Slew (“through 30 degrees within 60 seconds”) é um TBR do ADCS Lead, e o 5.3 Downlink Link Margin (“at least 3 dB link margin at 10 degrees elevation”) é um TBR do Comms Lead; ambos trazem valores de trabalho que os projetos usam enquanto as análises terminam.

Conte os itens em aberto em cada marco e espere que a contagem caia. Uma linha de base de requisitos com muitos TBDs em aberto é uma linha de base só no nome. Os critérios de revisão do Systems Engineering Handbook da NASA pedem, a partir da revisão de requisitos do sistema, que os itens TBD e TBR em aberto sejam identificados com um plano e um cronograma para encerrá-los. O acompanhamento pertence a um atributo ou a um registro, não só ao texto: um “TBD” digitado em uma frase não tem responsável nem data, e nada lembra ninguém de encerrá-lo.

Tipos de requisito

Classificar os requisitos ajuda os revisores a fazer as perguntas certas e ajuda o conjunto a se manter completo. As categorias abaixo são as mais comuns; a ISO/IEC/IEEE 29148 e o guia do INCOSE descrevem conjuntos semelhantes, e muitos projetos acrescentam as suas.

TipoO que declaraExemplo do EO-1Atenção a
FuncionalO que o sistema precisa fazer4.3 Fault Detection: “The C&DH shall enter safe mode within 10 seconds of undervoltage detection.”Uma função sem desempenho associado; a maioria dos requisitos funcionais também precisa de um “quão bem”, aqui “within 10 seconds”
DesempenhoQuão bem uma função é executada: quantidade, taxa, precisão, tempo2.1 Pointing Accuracy: “The ADCS shall point the payload boresight within 0.1 degrees of the commanded target.”Condições ausentes (qual modo, qual fase de vida) e sentido do limite ausente
InterfaceO que atravessa uma fronteira com outro sistema ou elemento, e suas características5.2 UHF Command Uplink: “The UHF transceiver shall receive ground commands at 9.6 kbps.” A definição completa fica no documento de controle de interfaces.Requisitos que repetem o ICD em vez de apontar para ele, de modo que os dois se distanciam
RestriçãoUm limite sobre o projeto ou sobre como o sistema é construído, imposto de fora4.4 Downlink Encryption: “The C&DH shall encrypt each downlink frame with 256-bit keys.” Sua justificativa: o contrato do cliente exige imagens criptografadas em trânsito, então o requisito vem de fora do projeto, não de um trade-off dentro dele.Escolhas de projeto escritas como restrições quando ninguém de fora as impôs
Ambientais, de confiabilidade, de segurançaCondições a suportar e confiabilidade a alcançar1.7 Mission Lifetime: “The spacecraft shall operate in orbit for at least 730 days.”Valores sem a probabilidade ou a confiança com que são afirmados

A linha entre requisitos funcionais e de desempenho muitas vezes é traçada dentro de uma frase: muitos requisitos declaram uma função com seu desempenho, como faz o 4.3. Não há problema, desde que a frase continue tendo uma única obrigação. Os requisitos de interface são tratados com mais profundidade no guia de documento de controle de interfaces, e as funções por trás dos requisitos funcionais no guia de análise funcional.

Exemplo prático: revisando a especificação do EO-1

Uma revisão do SRS-001 com a checklist divide os 32 requisitos em três grupos. A maioria passa. Alguns têm constatações menores que valem uma frase cada. Três precisam ser reescritos.

Uma checagem automática da mesma especificação concorda com a revisão: 29 de 32 requisitos têm nota boa, e os três fracos precisam de retrabalho. As constatações do 2.5 listam cada regra violada por nome e número, que é o que um autor precisa para corrigi-lo. A checagem também marca o que não consegue decidir: no 3.1, correção e viabilidade aguardam um revisor porque o texto mudou após a última revisão.

Constatações menores

  • 1.6.2 Off-Nadir Imaging, “up to 25 degrees off nadir”: “up to” se lê como máximo, mas a intenção é uma capacidade que a espaçonave precisa ter em qualquer ângulo de 0 a 25 graus. Uma leitura errada deixaria em conformidade um projeto que só fotografa no nadir.
  • 1.6.1 Ground Track Repeat, “its ground track”: um pronome com um único referente possível, então a constatação é menor. O “every” na mesma frase é um falso positivo de uma regra de quantificador universal.
  • 1.5 Daily Collection Volume tem um método (análise) e critérios de sucesso (“Simulated daily volume of at least 3.2 GB over a 30-day plan”), mas ainda nenhuma análise vinculada. A redação está boa; a verificação não está feita.
  • 3.1 Orbit Average Power está bem escrito, mas seu texto mudou após a aprovação, então sua correção e viabilidade precisam de novo do julgamento de um revisor. A viabilidade é a questão real: os painéis, como projetados, dão cerca de 28 W de média por órbita.

Três reescritas

2.5 Safe Mode Recovery. “The spacecraft should recover from safe mode quickly and resume imaging as appropriate” viola pelo menos seis regras: “should” em vez de “shall”, duas obrigações unidas por “and”, “quickly” sem valor, a cláusula de escape “as appropriate”, nenhum ponto final e nenhuma verificação. A reescrita mantém o único resultado que importa ao cliente e lhe dá um valor:

The spacecraft shall resume imaging within 6 hours of a safe mode entry.

A justificativa deve dizer de onde vêm as 6 horas (N1 pede alertas de estresse da lavoura no mesmo dia, e o 6.2 permite 6 horas do downlink à entrega). Se as etapas da recuperação importam por si mesmas, como readquirir o apontamento para o Sol ou informar a causa, cada uma se torna um requisito próprio. Método: teste, por injeção de falhas no flatsat; critério de sucesso: o imageamento é retomado em até 6 horas em cada entrada em modo de segurança injetada.

3.5 Battery Thermal Control. “The thermal design shall keep the battery warm enough (TBD).” tem um termo vago, um TBD no texto e parênteses. A correção separa a obrigação, o valor em aberto e o motivo:

The thermal design shall keep the battery cell temperature at or above 0 °C while charging.

Os 0 °C são ilustrativos: células de íon-lítio normalmente não são carregadas abaixo do ponto de congelamento, mas o limite real vem da folha de dados da célula e da análise térmica. Até essa análise defini-lo, o valor é um TBR do Thermal Engineer, com prazo antes da revisão do projeto térmico. A reescrita também expõe uma lacuna que o original escondia: não há requisito para a faixa de temperatura de descarga, que precisa da sua própria declaração.

6.4 Operator Interface. “The operator interface shall be user friendly and/or easy to use.” tem dois termos subjetivos e um “and/or”. A usabilidade pode ser especificada, mas só por meio de tarefas observáveis:

The operator interface shall let a trained operator book a ground station contact in no more than 5 minutes.

A tarefa e o tempo são ilustrativos. Um conjunto real listaria as poucas tarefas que importam (reservar um contato, enviar uma lista de alvos, ler a telemetria de saúde mais recente), cada uma com um tempo e um limite de erros, medidos em uma demonstração com operadores que concluíram o treinamento.

Erros comuns

ErroO que dá erradoMelhor
Escrever soluções de projeto como requisitosO projeto fica fixado antes de o trade-off ser feito, e uma opção melhor é descartada sem que ninguém decida isso.Declare a necessidade (“manter as células a 0 °C ou mais durante a carga”) e deixe o nível abaixo escolher o aquecedor.
Copiar a linguagem das partes interessadas direto para os requisitos“Imagens recentes duas vezes por semana” é uma necessidade; como está escrita, não é verificável.Mantenha a necessidade e escreva um requisito com um valor e uma condição que a satisfaça (1.6 within 72 hours).
Vários requisitos em um parágrafoUm identificador carrega várias obrigações, que compartilham um status, um teste e um destino.Um requisito por item, um “shall” por declaração.
Valores sem condições“30 W” no início de vida e no fim de vida são projetos diferentes.Declare modo, fase de vida, ambiente e forma de cálculo da média.
Sem justificativaNinguém consegue avaliar uma mudança posterior, e o requisito sobrevive muito depois de o motivo ter desaparecido.Escreva o motivo e os números por trás do valor.
Limites de teste não derivados do requisitoUm teste é aprovado enquanto o requisito não é cumprido (TC-06 com 72 W de pico contra 28 W de média por órbita).Derive o critério de sucesso da declaração por meio de contas, e registre-o.
TBD digitado no texto e esquecidoO valor em aberto não tem responsável nem data e chega à linha de base.Acompanhe cada TBD e TBR com um responsável, um prazo e um plano de encerramento.
Gold platingRequisitos que ninguém pediu consomem esforço de projeto e de testes.Cheque se cada requisito de nível mais alto é rastreado até uma necessidade ou uma fonte.
Confiança excessiva nas checagens automáticasUma checagem de palavras limpa é tomada por um requisito correto.Use ferramentas para as regras mecânicas; uma pessoa julga se é correto, viável e necessário.

Experimente no Holarch

Em um projeto LML, cada requisito é uma entidade da classe Requirement com os atributos descritos acima: Rationale, Status, Priority, Criticality, Owner, Source, Verification Method, Verification Level, Success Criteria e os campos de TBD/TBR.

  1. Crie a demonstração com Gerenciar projetos → Arquivos de projeto ▾ → Novo projeto de demonstração → CubeSat (engenharia de sistemas guiada). Sua especificação contém os três requisitos fracos e os itens TBD/TBR em aberto usados neste guia.
  2. Abra Necessidades e requisitos → Qualidade, escolha o documento na lista de escopo e clique em Checar qualidade. Cada requisito recebe nota nas nove características, e as sugestões citam os números das regras do guia do INCOSE que uma lista de palavras ou um padrão consegue checar. Correto e Viável precisam de um revisor: clique na marca para registrar a decisão.
  3. Reescreva o 2.5 como acima e execute a checagem de novo. As constatações de combinador, cláusula de escape e termo vago desaparecem.
  4. Abra Necessidades e requisitos → TBD/TBR para ver os itens em aberto com responsáveis e prazos, e Encerre um quando seu valor estiver definido.
  5. Para uma segunda opinião sobre as características que uma regra não consegue decidir, use ✦ AI ▾ → Checagem de requisitos por IA; cada veredito e cada reescrita é mostrado para revisão antes que algo mude.

A referência completa está na documentação de Qualidade dos requisitos e do Registro de TBD/TBR.

Baixe a checklist

A checklist de qualidade de requisitos com exemplos de antes e depois do EO-1 (CSV) contém as regras da checklist com suas perguntas de revisão e exemplos, para uso em uma revisão ou como ponto de partida para as regras de redação do próprio projeto. O mesmo arquivo é oferecido pelo guia de rastreabilidade.

Perguntas sobre a redação de requisitos

Shall, must ou will?

Qualquer convenção funciona se a especificação a definir e a seguir. A mais difundida usa “shall” para requisitos obrigatórios, “will” para fatos e intenções sobre coisas fora do sistema e “should” para metas que não são verificadas. Alguns guias de estilo governamentais preferem “must” por razões de linguagem simples. Misturá-las dentro de uma especificação é o verdadeiro problema.

Quantos requisitos um sistema deve ter?

Não existe número certo. Uma espaçonave pequena pode ter algumas dezenas de requisitos de sistema e algumas centenas abaixo deles; um programa grande tem milhares. Perguntas mais úteis são se cada requisito é rastreado até uma necessidade ou um pai, e se cada necessidade tem requisitos abaixo dela.

User stories são requisitos?

Uma user story registra uma necessidade e sua finalidade nos termos do usuário. Ela cumpre o papel de uma necessidade da parte interessada, e seus critérios de aceitação são próximos dos critérios de verificação. Para um sistema que é construído, integrado e verificado como hardware e software juntos, as histórias ainda precisam ser transformadas em requisitos que possam ser alocados e testados.

Uma ferramenta consegue checar a qualidade dos requisitos?

Uma ferramenta consegue checar as regras mecânicas de forma confiável: verbos modais, combinadores, palavras vagas, cláusulas de escape, pronomes, vínculos ausentes. Ela não consegue saber se 30 W é o valor certo nem se os painéis conseguem entregá-lo. Use a checagem automática para eliminar as constatações mecânicas antes de uma revisão, para que os revisores dediquem seu tempo à correção e à viabilidade.

Para onde ir a seguir