Requisitos
Requisitos
Escreva, cheque, aprove, coloque em linha de base e importe requisitos, e acompanhe itens TBD/TBR em aberto e vínculos a revisar.
Nesta página
- Visão geral
- Conceitos
- Como usá-lo
- Quando e por quê
- Escrever um requisito
- Checar a redação
- Escrever com modelos EARS
- Aprovar requisitos
- Congelar um documento para uma revisão
- Tratar uma mudança após a linha de base
- Fechar itens TBD e TBR
- Importar uma especificação existente
- Exemplo prático: a demonstração CubeSat EO-1
- Dicas e boas práticas
- Erros comuns
- Como se conecta a outros recursos
- A página Requisitos
- Qualidade dos requisitos
- Aprovações
- Registro de TBD/TBR
- Vínculos a revisar
- Linhas de base e comparação de versões
- Importar requisitos
- Atalhos dos requisitos
- Ajustes
- Mensagens
- Limites
- Relacionado
Visão geral
Use as páginas de requisitos para escrever, checar, aprovar e colocar requisitos em linha de base, e para acompanhar o que ainda está em aberto. Um requisito é uma entidade da classe LML Requirement: uma capacidade, característica ou fator de qualidade que o sistema precisa ter.
Os requisitos costumam ficar em um documento de requisitos (veja Documentos). Cada um continua sendo uma entidade do modelo. Por isso o mesmo requisito aparece no Banco de dados, nos diagramas, na Matriz de rastreabilidade e na RVTM.
O grupo Necessidades e requisitos da barra de navegação reúne todas as páginas de requisitos:
| Página | O que mostra |
|---|---|
| Documentos | Especificações e suas estruturas. Os requisitos são escritos aqui. |
| Requisitos | Todos os requisitos em uma tabela (o Banco de dados filtrado por class:Requirement). |
| Qualidade | A Qualidade dos requisitos: uma pontuação em nove critérios por requisito. |
| TBD/TBR | O registro dos valores em aberto que ainda precisam ser determinados ou revisados. |
| Vínculos a revisar | Vínculos cujo requisito a montante mudou depois da última revisão do vínculo. |
| Aprovações | Requisitos cujo Status é Em revisão. |
| Importar e exportar | Importação de Word, Excel, CSV, ReqIF, texto simples, XMI e arquivos de projeto, por uma única área de soltura, e as exportações do modelo. |
As linhas de base são instantâneos congelados para revisões. Crie-as a partir de um documento ou em Controle e revisões → Linhas de base e versões. Os vínculos com funções, assets e testes são tratados em Rastreabilidade.
Conceitos
Requirement e Statement
Statement é a classe pai de Requirement.
- Use um Statement para texto que não é obrigatório: títulos de seção, premissas, contexto.
- Use um Requirement para cada declaração obrigatória com "shall".
Apenas os Requirements são pontuados pela checagem de qualidade, listados no registro de TBD/TBR, marcados para revisão quando mudam e contados na RVTM. Os Statements são ignorados.
Um requisito tem os campos comuns de entidade Número, Nome e Descrição. A Descrição é a própria declaração do requisito, como texto formatado. Os atributos abaixo acrescentam o resto.
Atributos de requisito
| Atributo | Tipo e valores | Significado |
|---|---|---|
| Justificativa | Texto longo | O motivo por trás do requisito. |
| Status | Rascunho, Em revisão, Aprovado, Rejeitado | Onde o requisito está no fluxo de aprovação. |
| Prioridade | High, Medium, Low | Quão importante o requisito é para as partes interessadas. |
| Criticidade | High, Medium, Low | Consequência para a missão ou para a segurança se o requisito não for atendido. |
| Responsável | Texto | Pessoa ou equipe responsável pelo requisito. |
| Origem | Texto | Parte interessada, documento ou norma de onde o requisito vem. |
| Método de verificação | Seleção múltipla: Analysis, Demonstration, Inspection, Test | Como o requisito é verificado. |
| Nível de verificação | Component, Subsystem, System | Nível de montagem em que o requisito é verificado. |
| Critérios de sucesso | Texto longo | Resultado mensurável que mostra que o requisito é atendido. |
| TBD/TBR | None, TBD, TBR | TBD = um valor ainda precisa ser determinado; TBR = um valor precisa ser revisado. Volte para None quando fechado. |
| Responsável pelo TBD | Texto | Pessoa responsável por fechar o TBD/TBR. |
| Prazo do TBD | Data e hora | Data até a qual o TBD/TBR precisa ser fechado. Prazo, no grupo Fluxo de trabalho, mostra e define a mesma data (veja Registro de TBD/TBR). |
| Pontuação de qualidade | Porcentagem, calculada | Resultado da última checagem de qualidade. |
| Apropriado, Completo, Conforme, Correto, Viável, Necessário, Singular, Inequívoco, Verificável | Sim/Não, calculado ou definido manualmente | Os nove critérios de qualidade. |
O inspetor agrupa os campos de um requisito (veja O inspetor): Requirement (Número, Nome, Descrição, Rótulos, Justificativa, Origem, Critérios de sucesso), Fluxo de trabalho (a faixa de revisão com Status, Prioridade, Criticidade, Responsável, Atribuído a, Prazo, TBD/TBR, Responsável pelo TBD, Prazo do TBD), Verificação (Método e Nível de verificação, Verificado por, e os campos de fechamento com o Programa formal), Valores (Quantidade orçada, Limiar, Objetivo e Valor atual, Unidades), Conformidade (Programa formal) e Qualidade.
A pontuação e os nove critérios ficam no grupo Qualidade, recolhido no início. Seu título diz, por exemplo, "89% · 8 de 9 atendidos", ou "ainda não checado". O Holarch lembra, por classe, se você deixou o grupo aberto.
Os projetos podem acrescentar seus próprios atributos e opções de requisito; veja Extensões de esquema.
Rótulos de requisito
Os rótulos classificam requisitos sem mudar sua classe. Os rótulos de requisito nativos são:
- Requisito funcional, Requisito de desempenho, Requisito de interface.
- Requisito ambiental, Requisito de confiabilidade, Requisito de segurança.
- Verification Requirement.
- Necessidade das partes interessadas: uma necessidade declarada por uma parte interessada, antes de ser transformada em requisitos de sistema.
Método de verificação também é um grupo de rótulos, com os rótulos Analysis, Demonstration, Inspection e Test. O rótulo e o atributo ficam sincronizados, na mesma etapa de desfazer:
- Adicionar o rótulo Test define o Método de verificação como Test.
- Escolher Test no atributo adiciona o rótulo.
Projetos antigos e importações que trazem apenas os rótulos são incorporados ao atributo quando o projeto abre.
O fluxo de trabalho dos requisitos
Cada requisito passa por quatro status:
- Rascunho: em redação.
- Em revisão: aguardando uma decisão. Listado na página Aprovações.
- Aprovado ou Rejeitado: decidido. Cada decisão registra quem a tomou, quando e um motivo opcional.
Após a aprovação, três mecanismos mantêm o registro fiel:
- Nova revisão ao editar. Editar o nome ou a descrição de um requisito Aprovado o faz voltar para Em revisão, com a nota "Texto alterado após a aprovação".
- Qualidade desatualizada. Editar o nome ou a descrição marca seus resultados de qualidade como desatualizados e limpa as substituições manuais de qualidade.
- Vínculos a revisar. Editar o nome, a descrição ou um atributo-chave marca para revisão os vínculos com os itens a jusante dele.
As três coisas fazem parte da edição, então um único Desfazer (⌘Z / Ctrl+Z) as reverte juntas.
Itens em aberto: TBD, TBR e TBS
Um item em aberto é um valor que ainda não está definido. Um requisito é um item em aberto quando uma destas condições é verdadeira:
- Seu atributo TBD/TBR é TBD ou TBR.
- Seu nome ou sua descrição contém a palavra TBD, TBR ou TBS.
Os itens em aberto aparecem no registro de TBD/TBR até serem fechados.
Linhas de base
Uma linha de base é um instantâneo somente leitura. Há dois tipos:
- Uma linha de base de documento contém um documento. Ela inclui o artefato do documento, seus itens e os atributos deles, os relacionamentos que os tocam, as entidades a um salto de distância e os ajustes de estrutura do documento.
- Uma linha de base de projeto contém todas as entidades e relacionamentos do projeto.
As linhas de base podem levar registros de aprovação (nome, função, declaração, data). Os registros ficam bloqueados depois de salvos.
Como usá-lo
Quando e por quê
O trabalho com requisitos abrange o lado esquerdo do V da engenharia de sistemas:
- Capturar as necessidades das partes interessadas.
- Derivar os requisitos de sistema.
- Checar se cada declaração está bem formada.
- Obter a aprovação dos requisitos.
- Congelá-los em uma revisão (SRR, PDR, CDR).
Após a linha de base, o trabalho passa ao controle de mudanças. Cada mudança é revisada de novo e seu impacto a jusante é checado. Os valores TBD/TBR em aberto são fechados antes de o projeto ser consolidado.
As páginas de requisitos respondem a estas perguntas:
| Pergunta | Página |
|---|---|
| Cada requisito está bem escrito? | Qualidade |
| Quais valores ainda são desconhecidos, quem é responsável por eles, e estão atrasados? | TBD/TBR |
| O que precisa ser checado de novo porque um requisito mudou? | Vínculos a revisar |
| O que está aguardando uma decisão? | Aprovações |
| O que mudou desde a revisão? | Versão ▾ → Comparar versões… do documento, Linhas de base e versões |
| Cada requisito está alocado e verificado? | Matriz de rastreabilidade e RVTM |
As páginas Qualidade, Vínculos a revisar, TBD/TBR e Aprovações ficam lado a lado em Necessidades e requisitos na barra de navegação. Percorra as quatro checagens uma após a outra a partir dali.
Escrever um requisito
- Abra Necessidades e requisitos → Documentos.
- Abra o documento de requisitos.
Para começar um novo, clique em + Novo documento (veja Documentos).
- Na barra Adição rápida abaixo do documento, escolha onde o item vai, por exemplo Sob 3 Electrical Power.
- Digite a declaração do requisito e pressione Enter.
O Holarch adiciona um item da classe padrão do documento (Requirement em um documento de requisitos). Ele é numerado depois de seus irmãos.
- Com o requisito selecionado, abra o inspetor à direita.
- Preencha Justificativa, Origem e Critérios de sucesso no grupo Requirement, Prioridade, Criticidade e Responsável em Fluxo de trabalho, e Método de verificação e Nível de verificação em Verificação.
- Adicione um rótulo de tipo com + Rótulo no grupo Requirement do inspetor, por exemplo Requisito de desempenho. (A coluna Rótulos está em Exibir ▾ → Colunas ▸.)
O requisito tem o Status Rascunho e aparece em Necessidades e requisitos → Requisitos.
Se um valor ainda não é conhecido:
- Escreva sua melhor estimativa na declaração.
- Defina TBD/TBR como TBD.
- Preencha Responsável pelo TBD e defina a data em Prazo, no grupo Fluxo de trabalho.
O requisito agora também aparece no registro de TBD/TBR, com esse prazo.
Checar a redação
- Abra Necessidades e requisitos → Qualidade.
A partir de um documento, escolha Checar ▾ → Checar qualidade.
- Na barra de escopo, escolha Todos os requisitos ou Documento: <name>.
- Clique em Checar qualidade no cabeçalho da página.
A notificação diz "32 requisitos checados" (ou a sua contagem). Cada requisito recebe uma pontuação de 0 a 100% e um ✔ ou ✘ por critério.
Com mais de 2.000 requisitos, a checagem é executada em segundo plano: o cartão de progresso mostra "Checando os requisitos", a contagem e o tempo restante, e você pode continuar trabalhando. Clique em Cancelar no cartão para parar; nada muda. Depois, o cartão diz "Salvando os resultados de qualidade" com a contagem salva; enquanto salva, outras edições são recusadas com "Salvando os resultados de qualidade. Tente de novo quando terminar." Apenas os requisitos cujos resultados mudaram são salvos, então checar de novo sem mudanças não salva nada. A checagem inteira é uma única etapa: um ⌘Z / Ctrl+Z a remove.
- Leia os blocos: Requisitos, Pontuação média, Bom (≥ 67%), Requer retrabalho (< 67%) e, quando houver, Desatualizado (texto alterado).
- Para cada requisito abaixo de 67%, leia a coluna Sugestões.
Ou aponte para um ✘ para ver as mensagens desse critério.
- Clique no nome do requisito para abri-lo e corrija o texto.
- Execute a checagem de novo.
Correto e Viável sempre exigem o julgamento de uma pessoa. A checagem nunca os marca como atendidos, seja o que for que as outras checagens encontrem. Assim, a checagem automática chega a no máximo 7 de 9 critérios (78%). Um requisito sem teste ou requisito que o verifique chega a 6 de 9 (67%). Para cada requisito, decida-os você mesmo:
- Depois de revisar o requisito, clique no ✘ para marcar o critério como Sim.
- Para uma primeira opinião, use ✦ IA ▾ → Checar com IA (N requisitos)… (a Checagem de requisito por IA).
Nota: As pontuações armazenadas por versões anteriores podiam contar Correto ou Viável como atendidos quando outra checagem falhava. Execute a checagem de novo para atualizá-las.
Escrever com modelos EARS
O EARS (Easy Approach to Requirements Syntax) escreve cada requisito como uma frase: uma condição opcional e depois "the [system] shall [response]". A primeira palavra da condição define o padrão.
| Padrão | Modelo | Exemplo |
|---|---|---|
| Ubiquitous | The [system] shall [response]. | The pump controller shall record every start command with its time. |
| Event-driven | When [trigger], the [system] shall [response]. | When the tank level falls below 20 %, the pump controller shall start the backup pump. |
| State-driven | While [state], the [system] shall [response]. | While the vehicle is charging, the battery manager shall keep each cell below 45 °C. |
| Unwanted behavior | If [unwanted condition], then the [system] shall [response]. | If the supply voltage drops below 10 V, then the flight computer shall switch to the reserve battery. |
| Optional feature | Where [feature is included], the [system] shall [response]. | Where a heated windshield is fitted, the climate controller shall clear frost within 5 minutes. |
| Complex | While [state], when [trigger], the [system] shall [response]. | While the drill is in standby, when the operator presses Start, the drill controller shall reach full speed within 3 s. |
- Abra um requisito no inspetor ou na Visão do item.
- Clique em EARS ▾ ao lado de Descrição.
A primeira linha mostra o padrão da declaração (✓ Event-driven) ou o que corrigir (Nenhum padrão EARS: 1 a corrigir).
- Escolha um padrão.
O modelo dele vira a descrição. Se o requisito já tiver uma, confirme com Substituir; a declaração antiga fica no histórico do item. Um ⌘Z / Ctrl+Z desfaz isso.
- Substitua as palavras entre colchetes.
Para checar todos os requisitos, defina Requirement.11 como Aviso ou Erro em Checagens do modelo → Ajustes. Ela fica desativada por padrão.
Em um projeto SysML v2, EARS ▾ fica abaixo da Documentação de um requisito no inspetor e escreve o comentário doc dele.
Aprovar requisitos
- Quando um requisito estiver pronto, defina seu Status como Em revisão.
Faça isso no inspetor (o Status na faixa de revisão do grupo Fluxo de trabalho), no Banco de dados ou em uma coluna de documento.
- O revisor abre Necessidades e requisitos → Aprovações.
A página lista todos os requisitos cujo Status é Em revisão.
- Clique em uma linha.
O grupo Fluxo de trabalho do inspetor mostra a faixa de revisão: o Status, quem o definiu e quando ("por J. Rivera · 9 de mar. de 2026 às 9:58") e os botões.
- Clique em Aprovar.
Ou clique em Rejeitar… e insira um motivo opcional.
A notificação diz "Aprovado" ou "Rejeitado". A decisão é registrada com o seu nome e a hora, e o requisito sai da lista de Aprovações.
Quando o requisito está em uma linha de base e há itens de verificação ou documentos rastreados até ele, Aprovar primeiro abre um diálogo que os lista em Requer nova revisão (Impacto). Clique em uma linha para examiná-la e depois em Aprovar para confirmar.
Para mandar um requisito decidido de volta para revisão, clique em Reabrir. A notificação diz "Movido para Em revisão".
Se o projeto tem um fluxo de trabalho no Status dos requisitos (Esquema → Fluxo de trabalho), a faixa de revisão mostra as transições desse fluxo em vez de Aprovar, Rejeitar… e Reabrir. Uma transição que exige aprovação termina em … e abre Solicitar aprovação: veja Solicitar aprovação para uma mudança de estado. Para um requisito em linha de base, Solicitar aprovação e o diálogo Aprovar… da solicitação de mudança mostram a mesma lista Requer nova revisão.
Congelar um documento para uma revisão
- No bloco de título do documento, clique em Versão ▾.
- Escolha Salvar linha de base….
Ou escolha Entregar ▾ → Versão ▸ Salvar linha de base….
- Mantenha ou altere o Nome. O padrão é "<document> Baseline <n>".
- Em Aprovações, preencha uma linha por aprovador: Nome, Função e Declaração (padrão "Aprovado para liberação.").
+ Adicionar aprovador adiciona uma linha; × remove uma.
- Clique em Criar.
A notificação diz "Linha de base salva". Versão ▾ diz "Atual · última linha de base <name>".
A partir de agora, cada linha ganha uma barra de mudança quando difere da linha de base mais recente.
Tratar uma mudança após a linha de base
- Edite o texto do requisito no documento.
Uma notificação resume o que aconteceu, por exemplo "1 requisito aprovado movido para Em revisão; 6 vínculos marcados para revisão." Como parte da sua edição (um único Desfazer reverte tudo):
- Um requisito Aprovado passa para Em revisão.
- Seus resultados de qualidade ficam desatualizados ("Qualidade: desatualizada — executar de novo").
- Seus vínculos a jusante são marcados para revisão.
- Abra Necessidades e requisitos → Vínculos a revisar.
- Para cada linha, clique em Diff para ver a mudança no texto e revise o item vinculado.
- Quando um item vinculado continuar válido, clique em Marcar como revisado… na linha dele.
Para marcar vários de uma vez, selecione as linhas deles e clique em Marcar selecionados como revisados….
- Escreva o que você checou e clique em Marcar como revisado.
- Execute a checagem de qualidade de novo.
- Mande o requisito de novo pela aprovação.
- Clique em Versão ▾ → Comparar versões…, escolha a linha de base em De e Versão atual em Para.
O relatório lista todas as mudanças desde a linha de base.
- Clique em Alterações (Excel) para o comitê de mudanças.
Fechar itens TBD e TBR
- Abra Necessidades e requisitos → TBD/TBR.
- Leia os blocos: TBD/TBR em aberto, Atrasados, Sem responsável e a contagem por documento.
- Trate primeiro as linhas atrasadas. Elas ficam coloridas, com "Atrasado" abaixo do prazo.
- Onde o responsável mostra "—", atribua um Responsável pelo TBD.
- Quando um valor estiver definido, edite o texto do requisito para o valor final.
- Clique em Fechar na linha.
Fechar define TBD/TBR como None, e a linha sai do registro.
Para enviar o registro aos responsáveis, clique em Exportar XLSX.
Importar uma especificação existente
- Abra Necessidades e requisitos → Importar e exportar.
- Solte o arquivo na área de soltura, ou clique nela para escolher o arquivo: Word (.docx), Excel ou CSV, ReqIF ou texto simples.
A linha de status diz, por exemplo, "“SRS.docx” analisado: 48 linhas, 5 colunas." Formato mostra o formato detectado.
- Clique em Continuar.
- Confira para o que cada coluna é mapeada e defina Classe para linhas sem classe como Requirement.
- Clique em Continuar.
- Mantenha marcada a opção Criar um documento de requisitos a partir destes N requisitos, confira o tipo e o nome do documento, e confira os itens novos e atualizados e os avisos.
- Clique em Importar N itens.
Sem avisos, o Holarch abre o novo documento. Com avisos, o cartão Importação concluída os lista.
O cartão Importação concluída tem botões para abrir o documento, o Banco de dados, um diagrama Spider ou de árvore, ou a checagem de qualidade. Um ⌘Z / Ctrl+Z remove a importação inteira.
Exemplo prático: a demonstração CubeSat EO-1
Crie o projeto de demonstração CubeSat EO-1 — Earth Observation Demo em Gerenciar projetos. Ele tem uma especificação de 32 requisitos, SRS-001 EO-1 System Requirements Specification, com uma linha de base da SRR e mudanças feitas depois dela.
Qualidade.
- Abra Necessidades e requisitos → Qualidade e clique em Checar qualidade.
Os blocos mostram 32 requisitos, uma média de 92%, 29 Bom e 3 Requer retrabalho.
Os três requisitos fracos foram escritos assim de propósito. Cada um tem 44%:
- 2.5 Safe Mode Recovery: "The spacecraft should recover from safe mode quickly and resume imaging as appropriate". As sugestões incluem:
- "R34 - Termo(s) de desempenho que não pode(m) ser medido(s): [quickly]"
- "R8 - Cláusulas de escape enfraquecem o requisito: [as appropriate]"
- "R19 - Une dois requisitos; separe-os em requisitos independentes: [and]"
- "Termine o enunciado com um ponto final."
- "Vincule um Test Case ou Requirement que o verifique."
- 3.5 Battery Thermal Control: "…keep the battery warm enough (TBD)." As sugestões são "R21 - Contém parênteses; mova o texto entre parênteses para a justificativa." e "Substitua os marcadores TBD/TBR."
- 6.4 Operator Interface: "…shall be user friendly and/or easy to use." As sugestões são "R34 - Termo(s) de desempenho que não pode(m) ser medido(s): [user friendly, easy to use]" e "R19 - “e/ou” é ambíguo; indique se se trata de ambos ou de qualquer um: [and/or]".
Para corrigir o 2.5:
- Reescreva-o como "The spacecraft shall resume imaging within 6 hours of a safe mode entry."
- Vincule um caso de teste com verified by.
- Execute a checagem de novo.
As mensagens de combinador, de cláusula de escape e de termo vago desaparecem.
TBD/TBR. Abra TBD/TBR. Ele mostra três itens em aberto:
- 3.5 Battery Thermal Control: um TBD cujo responsável é o Thermal Engineer. Está atrasado.
- 2.4 Target Slew (ADCS Lead) e 5.3 Downlink Link Margin (Comms Lead): TBRs com prazo posterior.
Mudança após a linha de base. Versão ▾ do documento lista SRR Baseline. Ela foi aprovada por J. Rivera (Systems Lead), R. Okafor (Mission Principal Investigator) e L. Brandt (Program Manager).
Após a SRR, o requisito 3.1 Orbit Average Power mudou de 28 W para 30 W. Como o 3.1 estava Aprovado, ele voltou para Em revisão com a nota "Texto alterado após a aprovação".
Vínculos a revisar lista seis vínculos a partir do 3.1:
- 1.3.1 Solar Arrays
- F3 Generate and Store Power e F3.1 Convert Sunlight to Power
- EQ-1.1 Solar Power Generation e EQ-1.4 Power Margin Check
- TC-06 Solar Array Power Test
Clique em Diff em qualquer linha: "28 W" aparece riscado e "30 W" inserido. Depois revise os itens:
- O TC-06 espera potência de pico ≥ 72 W e mediu 75,1 W. Por meio de EQ-1.3 Orbit-Average Array Power (pico × 0,62 de fração iluminada × 0,6 de eficiência do caminho de potência), 75,1 W correspondem a 27,9 W de média orbital, abaixo dos novos 30 W. Deixe esse vínculo sem revisão e adicione o comentário "75,1 W de pico = 27,9 W de média orbital; testar de novo com cerca de 80,6 W de pico". O teste precisa de um novo resultado esperado e de uma nova execução.
- Confira se o dimensionamento do painel solar ainda fecha antes de marcar o 1.3.1 como revisado.
Comparar com a versão atual. Escolha SRR Baseline em Versão ▾ e clique em Comparar com a versão atual no banner dela. O relatório lista:
- As mudanças de Descrição, Justificativa, Status e Pontuação de qualidade do 3.1.
- A mudança de Status do 2.4 Target Slew (Rascunho → Em revisão).
- O novo requisito 4.4 Downlink Encryption, com seus dois novos vínculos satisfies.
Aprovações. Abra Aprovações. Nove requisitos estão Em revisão, incluindo 3.1, 1.5 Daily Collection Volume e 5.3 Downlink Link Margin.
Dicas e boas práticas
- Escreva um "shall" por requisito, na voz ativa, com um número, uma unidade e uma condição. A checagem de qualidade recompensa exatamente isso.
- Coloque o motivo em Justificativa, não na declaração. Expressões de finalidade ("so that", "in order to") e parênteses são sinalizados como R20 e R21.
- Preencha o Método de verificação enquanto escreve. Um requisito com método, mas sem caso de teste, aparece então como Somente planejado na RVTM, em vez de Não verificado.
- Defina TBD/TBR com um responsável e um prazo, em vez de apenas digitar "TBD" no texto. O atributo dá ao registro um responsável e um prazo para acompanhar.
- Crie uma linha de base antes de cada revisão. As barras de mudança e Comparar com a versão atual só funcionam em relação a uma linha de base.
- Marque os vínculos como revisados com um comentário. O comentário é adicionado ao item vinculado e registrado no vínculo, para que a revisão deixe uma trilha de auditoria.
Erros comuns
| Sintoma | Causa | Correção |
|---|---|---|
| Um requisito não é pontuado, não está no registro ou não está na RVTM. | Ele é um Statement, não um Requirement. | Mude a classe dele para Requirement no inspetor. |
| Correto e Viável mostram ✘ em todos os requisitos. | Eles exigem o julgamento de uma pessoa ("Requer o julgamento de um revisor"). | Revise cada um e clique no ✘ para marcá-lo como Sim, ou execute a Checagem de requisito por IA. |
| A pontuação mostra "Desatualizado — executar novamente". | O texto mudou depois da última checagem. | Clique em Checar qualidade, ou ative Checar novamente de forma automática quando o texto mudar. |
| As substituições manuais de Sim/Não desapareceram. | Editar o texto as limpa. | Defina-as de novo após a revisão; Desfazer as restaura, e elas ficam no Histórico. |
| Um requisito saiu de Aprovado depois da correção de um erro de digitação. | Qualquer edição de nome ou de descrição reabre um requisito aprovado. | Aprove-o de novo. Corrija erros de digitação antes da aprovação. |
| "Fechar" não aparece em uma linha de TBD/TBR. | O item em aberto vem apenas do texto. | Edite o texto para remover TBD, TBR ou TBS. |
| Uma importação criou cópias em vez de atualizar. | Corresponder entidades existentes por não encontrou correspondência. | Exporte com a coluna ID, edite e importe com Corresponder entidades existentes por: ID global (veja Atualizar requisitos a partir de uma planilha). |
Como se conecta a outros recursos
- Recebe de: contribuições das partes interessadas e especificações existentes por meio de Importar, e documentos escritos em Documentos.
- Alimenta:
- Análise funcional: funções extraídas dos requisitos.
- A Matriz de rastreabilidade: satisfied by, verified by.
- A RVTM e a Central de testes: status da verificação.
- Checagens do modelo: regras de Requirement.1 a Requirement.10.
- Início: contagens de aprovação e de verificação.
- Exportações de documentos: constatações de Qualidade (Excel), RVTM, VCRM, mudanças.
- Revisões.
- IA: o menu ✦ IA ▾ do documento e da Visão do item tem Reescrever com clareza…, Adicionar critérios mensuráveis…, Simplificar…, Dividir requisito composto…, Rascunhar justificativa…, Sugerir nome… e Checar com IA (a Checagem de requisito por IA). As mudanças da IA são pré-visualizadas antes de serem aplicadas. Veja Perguntar à IA e ferramentas de IA.
A página Requisitos
Use a página Requisitos para ver e editar todos os requisitos em uma tabela. Necessidades e requisitos → Requisitos é o Banco de dados filtrado por class:Requirement.
Todos os recursos do Banco de dados funcionam aqui:
- Ordenar e filtrar colunas, e editar células no lugar.
- Selecionar linhas para a barra de ações em massa, para definir atributos ou rótulos em muitos requisitos de uma vez.
- Exportar e abrir a Matriz de rastreabilidade das linhas selecionadas.
Clique em uma linha para mostrar o requisito no inspetor. Clique duas vezes para abrir a Visão do item dele. Um requisito com um vínculo a revisar mostra um selo ⚠ Revisar na linha. Clique com o botão direito em uma linha para ver seu menu: até três ações sugeridas com seus motivos (por exemplo ✦ Adicionar critérios mensuráveis… quando o requisito falha em Inequívoco, ✦ Gerar caso de teste… quando ele não está verificado), ✦ Mais IA ▸, depois Abrir, Renomear…, Duplicar, Adicionar filho…, Status ▸, Prioridade ▸, Relacionar com ▸, Adicionar ao documento ▸, Mostrar no diagrama ▸, Copiar link, Copiar número e Excluir… (veja Menu do botão direito).
Veja O modelo e o banco de dados para a tabela, as consultas e a edição em massa.
Consultas úteis:
| Consulta | Mostra |
|---|---|
class:Requirement | Todos os requisitos. |
Requirement:"Status=In Review" | A lista de Aprovações. |
Requirement:"Status=Draft" | Requisitos ainda não enviados para revisão. |
class:Requirement AND is:leaf | Requisitos folha (sem requisitos filhos). |
class:Requirement AND NOT relationship:"verified by" | Requisitos sem um item que os verifique. |
Qualidade dos requisitos
Use a página Qualidade (título "Qualidade dos requisitos") para encontrar requisitos mal redigidos. Ela pontua cada requisito em nove critérios.
Os nove critérios e os números de regra nas sugestões (R2, R19 e assim por diante) seguem as características e regras do Guide to Writing Requirements do INCOSE. As listas de palavras e os padrões do Holarch aproximam essas regras; eles não são o texto do guia, e algumas regras exigem o julgamento de um revisor.
- Pontuação = 100 × (critérios atendidos) / 9, arredondada. Um critério que não foi checado (–, veja Requisitos em outros idiomas) fica de fora: 100 × atendidos / 8.
- 67% ou mais é Bom. Abaixo de 67% é Requer retrabalho.
- A barra é vermelha abaixo de 34%, amarela de 34% a 66% e verde a partir de 67%.
Layout da página
- Cabeçalho da página:
- Mais ▾: Limpar avaliações manuais redefine todos os Sim/Não manuais dos requisitos mostrados e executa a checagem de novo. Abrir em Requisitos abre os requisitos mostrados na tabela Requisitos. Abrir documento aparece quando o escopo é um documento.
- Exportar ▾: Excel (.xlsx) e CSV, dos requisitos mostrados.
- Checar qualidade: checa todos os requisitos do escopo, independentemente do que os filtros mostram (a regra de duplicatas compara cada requisito com os outros do escopo).
- ✦ IA ▾ (na barra superior): Checar com IA (N requisitos)…, a Checagem de requisito por IA dos requisitos mostrados.
- Barra de escopo: Escopo (Todos os requisitos ou Documento: <name>) e a caixa de seleção Checar novamente de forma automática quando o texto mudar. Vínculos a revisar, TBD/TBR e Aprovações ficam ao lado de Qualidade na barra de navegação.
- Barra de consulta: + Filtro, os chips de filtro e o texto de pesquisa, Limpar, ? (sintaxe de pesquisa) e Visões ▾: a mesma barra da página Requisitos (veja Filtrar a página Qualidade).
- Blocos: Requisitos ("12 de 40" abaixo de Requisitos exibidos quando filtros ocultam alguns), Pontuação média, Bom (≥ 67%), Requer retrabalho (< 67%) e Desatualizado (texto alterado) quando houver desatualizados. As pontuações desatualizadas ficam fora da média.
- Nota abaixo dos blocos: "As checagens automáticas alcançam no máximo 7 de 9 atributos (78%); Correto e Viável exigem verificação humana — clique em um ✘ para marcá-lo como Sim. Cada clique alterna entre Sim manual, Não manual e de volta ao automático."
- Tabela: Número, Nome (com a descrição abaixo), Pontuação de qualidade, uma coluna por critério e Sugestões. Sugestões lista todas as mensagens, precedidas por seu critério. As linhas são ordenadas por número. Clique com o botão direito em uma linha, ou pressione Shift+F10 nela, para o menu de linha do Banco de dados: ações sugeridas com seus motivos (a reescrita que corrige um critério com falha vem primeiro), ✦ Mais IA ▸, Abrir, Renomear…, Duplicar, Adicionar filho…, Status ▸, Prioridade ▸, Relacionar com ▸, Adicionar ao documento ▸, Mostrar no diagrama ▸, Copiar link, Copiar número e Excluir…. A linha vira a seleção.
- Várias linhas: ⌘ / Ctrl-clique (Ctrl-clique no Windows e no Linux) alterna uma linha, ⇧ / Shift-clique seleciona o intervalo a partir da última linha clicada, ⌘ / Ctrl+⇧ / Shift-clique adiciona esse intervalo, e ⌘A / Ctrl+A ou ⇧ / Shift+↑ / ⇧ / Shift+↓ em uma linha com foco selecionam todas as linhas ou estendem a seleção. A barra de ferramentas mostra a contagem; Esc a limpa. Clique com o botão direito em uma linha selecionada para agir sobre todas: ✦ Checar com IA (n requisitos)…, ✦ Reescrever (n) ▸, ✦ Gerar casos de teste (n)…, ✦ Perguntar à IA sobre estes (n)…, ✦ Sugerir rastreamentos (n)… (cada uma com uma única pré-visualização; veja IA em vários itens selecionados), Duplicar n entidades, Definir status ▸, Definir prioridade ▸, Adicionar ao documento ▸ e Excluir n itens…; um único Desfazer reverte cada uma. O Registro de TBD/TBR e Vínculos a revisar funcionam da mesma forma; em Vínculos a revisar, a seleção também marca as linhas para Marcar selecionados como revisados….
Casos especiais:
- Uma linha sem resultado mostra "Não executado" na coluna de pontuação.
- Uma linha desatualizada mostra "Desatualizado — executar novamente".
- Quando o escopo não tem requisitos, a página mostra "Nenhum requisito" e "Somente itens da classe Requirement são pontuados; Statements são ignorados."
- Quando os filtros ou o texto de pesquisa ocultam todos os requisitos, a página mostra "Nenhum requisito correspondente" e "Nenhum requisito corresponde à pesquisa ou aos filtros. Limpe-os para ver todos os requisitos."
Filtrar a página Qualidade
A barra de consulta funciona como na página Requisitos (veja Como os filtros digitados viram chips): os termos de filtro digitados viram chips quando você pressiona Enter, o restante do texto corresponde ao nome, ao número e à descrição, Backspace em uma pesquisa vazia remove o último chip, e Limpar remove todos. Os blocos, a tabela, Exportar ▾ e ✦ IA ▾ → Checar com IA seguem os filtros.
+ Filtro lista, com contagens para o escopo:
| Grupo | Filtros | Termo |
|---|---|---|
| Qualidade | Bom (≥ 67%), Requer retrabalho (< 67%), Não executado, Desatualizado (texto alterado), Avaliações manuais, Constatação da IA | quality:good, quality:rework, quality:notrun, quality:stale, quality:manual, quality:ai |
| Falha em um critério | Um por critério: avaliado como Não | quality:Verifiable=no (=yes: avaliado como Sim) |
| Constatação de regra | As regras encontradas no escopo, como R7 Redação imprecisa ou R30 Muito semelhante (possíveis duplicatas) | quality:R7 |
| Estrutura, Classe, Atributos do requisito, Rótulo, Relacionamento, Diagrama | Como na página Requisitos; os Atributos do requisito são listados sem chip de classe | is:tbd, Requirement:"Status=Draft", label:"…" |
Os filtros de um mesmo grupo se combinam com ou; grupos diferentes se combinam com e. Os intervalos de pontuação usam o atributo: Requirement:"Quality Score>=50". Os termos quality: também funcionam na página Requisitos e no Banco de dados.
Visões ▾ aplica uma visão nativa (Requer retrabalho, Ainda não checado, Resultados desatualizados, Ambíguo, Não verificável, Possíveis duplicatas, Avaliações manuais) ou uma das suas visões salvas. Salvar visão… salva os filtros e o texto de pesquisa atuais neste navegador, para todos os projetos; Excluir "<name>" aparece enquanto uma visão salva está em uso. Todos os requisitos limpa os filtros. O endereço quality?q=<query> abre a página filtrada.
A filtragem lê os resultados armazenados e não checa de novo. Em 50.000 requisitos, uma mudança de filtro ou de pesquisa leva bem menos de um décimo de segundo.
Critérios e checagens
Cada critério mostra uma de três marcas:
- ✔ (Sim): nenhuma mensagem.
- ✘ (Não): pelo menos uma mensagem.
- –: não checado.
As checagens correspondem a palavras e expressões inteiras, sem diferenciar maiúsculas e minúsculas. Só contam as formas listadas: "effective" e "effectively" estão ambas listadas, "effectiveness" não. Palavras entre aspas também contam. As mensagens abaixo são o texto exato mostrado. A lista entre colchetes no fim de uma mensagem nomeia as palavras encontradas.
Inequívoco
| Regra | Mensagem | Disparado por |
|---|---|---|
| R6 | R6 - Unidade(s) não reconhecida(s); use unidades padrão do SI, americanas ou imperiais: [...] | Um número seguido de uma palavra que não é uma unidade conhecida (por exemplo "12 sorties"). As unidades conhecidas incluem unidades do SI, americanas e imperiais e suas abreviações, %, graus, °C e °F. |
| R2 | R2 - Use a voz ativa: [...] | "shall/must/will/should be" seguido de um particípio passado ("shall be measured"). |
| R5 | R5 - Use artigos definidos (“o”, “a”) em vez de: [...] | "a" ou "an". |
| R7 | R7 - Redação imprecisa: [...] | some, many, several, few, little, much, various, appropriate(ly), adequate(ly), efficient(ly), effective(ly), sufficient(ly), reasonable, reasonably, suitable, suitably, significant(ly), minimal(ly), maximal(ly), approximately, almost, nearly, generally, usually, typically, normally, robust(ly), flexible, flexibly, easy, easily, etc, similar, relevant, substantial(ly), large, small, good, bad, better, best, worst, proper, properly, acceptable, acceptably, accurate(ly), extreme, high-contrast, high contrast. |
| R8 | R8 - Cláusulas de escape enfraquecem o requisito: [...] | if necessary, where possible, as appropriate, as practicable, as far as possible, if practical, as required, as needed, to the extent possible, if possible. |
| R10 | R10 - Locução(ões) infinitiva(s) desnecessária(s): [...] | to be designed to, to be able to, to be capable of, to enable, to allow, be able to, be capable of. |
| R16 | R16 - Evite a negação: [...] | not, n't, never. |
| R17 | R17 - Evite a barra (“/”). | Uma barra entre duas palavras, exceto km/h, m/s, and/or e seus equivalentes em alemão, francês, espanhol, italiano e holandês. |
| R24 | R24 - Pronome(s) em vez de substantivos explícitos: [...] | it, its, they, them, their, he, she, him, her, someone, something, anyone, anything, anybody, somebody, this, these, those. |
| R32 | R32 - Use “cada” em vez de quantificadores universais: [...] | all, any, both, every, everything, everyone. |
| R34 | R34 - Termo(s) de desempenho que não pode(m) ser medido(s): [...] | fast, quick, quickly, user friendly, user-friendly, high speed(s), high-speed, best practice(s), state of the art, state-of-the-art, seamless(ly), intuitive(ly), easy to use, timely, rapid, rapidly, real-time, real time. "Real-time clock" não conta: nomeia um componente. |
| R35 | R35 - Palavra(s) de tempo pouco clara(s): [...] | as, eventually, before, after, until, meanwhile, simultaneous(ly), soon, later, sometimes, occasionally, often, subsequently, previously. |
| — | Substitua os marcadores TBD/TBR. | TBD, TBR ou TBS na descrição (em maiúsculas). |
| — | IA: ambíguo — <reason> | Uma constatação da IA aceita na Checagem de requisito por IA. |
| — | Indica um máximo (“até”); se o sentido for um mínimo, use “pelo menos”. | "up to" seguido de um número, em algarismos ou por extenso ("up to 72 hours", "up to five tonnes"). "Up to date" não conta. |
Completo
| Regra | Mensagem | Disparado por |
|---|---|---|
| — | Descrição ausente. | Uma descrição vazia. |
| — | Nome ausente. | Um nome vazio. |
| R9 | R9 - Redação de lista aberta: [...] | including but not limited to, etc, and so on, and so forth, such as, among others. |
Singular
| Regra | Mensagem | Disparado por |
|---|---|---|
| R18 | R18 - Escreva uma única frase (foram encontradas N). | Mais de uma frase (também frases em japonês e chinês terminadas em 。, ! ou ?). |
| — | Termine o enunciado com um ponto final. | Uma descrição que não termina com "." (ou 。). |
| R19 | R19 - Une dois requisitos; separe-os em requisitos independentes: [...] | and, or, but, however ou whereas unindo duas ações ou duas obrigações ("shall log and report each fault", "… and the operator shall …"), "nor shall", uma segunda oração após ";"; "and/or" antes de uma segunda ação. Veja Dois requisitos em um (R19). |
| R19 | R19 - “e/ou” é ambíguo; indique se se trata de ambos ou de qualquer um: [and/or] | "and/or" entre valores ou em uma condição. |
| R19 | R19 - Une dois valores; separe-os se cada um for verificado separadamente: [...] | and, or unindo dois objetos ou valores após uma ação ("measure the temperature and the humidity"). Uma nota: Singular continua Sim. |
| R20 | R20 - Contém expressões de finalidade; mova-as para a justificativa: [...] | purpose of, in order to, so that, for the purpose of, so as to. |
| R21 | R21 - Contém parênteses; mova o texto entre parênteses para a justificativa. | "(" ou "[" (também colchetes e parênteses de largura total). |
Conforme
| Mensagem | Disparado por |
|---|---|
| Use um verbo modal: [need, shall, will, should, must] | Nenhuma destas palavras aparece. |
Apropriado
| Regra | Mensagem | Disparado por |
|---|---|---|
| R31 | R31 - Impõe uma solução: [...] | using, by means of, utilizing, utilising, implemented in, implemented with, via a, via the, built with, written in. |
Necessário
| Regra | Mensagem | Disparado por |
|---|---|---|
| R30 | R30 - Muito semelhante a: [3.2 Battery Capacity (81,3% semelhante), ...] | Outro requisito do escopo cuja descrição é pelo menos 75% semelhante (similaridade por pares de caracteres). A constatação nomeia até cinco e conta o resto ("e mais 3"). O pai direto e os filhos do requisito (decomposed by, decomposes) não são comparados: um refinamento muitas vezes repete a redação do pai. Irmãos e requisitos não relacionados são comparados. |
Verificável
| Mensagem | Disparado por |
|---|---|
| Vincule um Test Case ou Requirement que o verifique. | O requisito não tem vínculo verified by com um Requirement ou Test Case. |
| IA: não verificável como está escrito — <reason> | Uma constatação da IA aceita na Checagem de requisito por IA. |
Viável
| Regra | Mensagem | Disparado por |
|---|---|---|
| R26 | R26 - Termo(s) absoluto(s) raramente alcançável(is): [...] | always, never, 100%, 100 percent, all the time, totally, completely, absolutely, zero defects, forever, continuous, continuously, uninterrupted. |
| — | Requer o julgamento de um revisor | Nenhum termo absoluto e nenhuma quase duplicata foram encontrados; uma pessoa precisa decidir. |
Correto
| Mensagem | Disparado por |
|---|---|
| Requer o julgamento de um revisor | Todas as checagens de texto (Apropriado, Completo, Conforme, Necessário, Singular, Inequívoco) passaram; uma pessoa precisa decidir. |
Como Correto e Viável terminam com "Requer o julgamento de um revisor" até alguém decidir, a maior pontuação automática é 7 de 9 (78%).
Dois requisitos em um (R19)
Um requisito declara uma única coisa. O R19 examina cada "and", "or", "nor", "but", "however", "whereas", "as well as" e "and/or" e o classifica em um destes tipos:
| Tipo | Exemplo | Resultado |
|---|---|---|
| Dois requisitos | "The unit shall log and report each fault." "The pump shall stop, and the operator shall be alerted." "… to acknowledge alarms and to silence the horn." "…; it shall also …" | Uma constatação. Singular é Não. |
| "and/or" ambíguo | "The log shall record the user ID and/or the badge number." | Uma constatação: diga se se trata de ambos ou de um dos dois. Singular é Não. |
| Dois valores | "The station shall measure the temperature and the humidity." | Uma nota: divida-o se cada valor for verificado separadamente. Singular continua Sim; a nota aparece em cinza e não reduz a pontuação. |
| Nenhuma constatação | "between 5 °C and 30 °C"; "When A and B, the unit shall …"; "… when the door is open and the fan is off"; "requirements 2.1 and 2.2"; texto entre aspas; "The command and control unit shall …"; "ASME Boiler and Pressure Vessel Code"; "5 Nm at 3000 rpm and 24 V"; "including batteries and strap"; "either open or closed" | Nada. |
Dois valores de uma mesma grandeza ("at -20 °C and 60 °C") recebem a nota. Um ", and" encerra uma condição: "… when the level falls below 10 %, and restart when …" é uma constatação. Um sujeito que age como um só ("The Owner and the Contractor shall agree …", "The power and data connector shall …") não recebe nota; dois sujeitos que agem cada um ("The pump and the valve shall close …") recebem a nota. Comparadores ("12 or more") não são sinalizados. Um nome após a ação não pode ser distinguido de dois valores, então liste-o em Nomes compostos.
Nomes compostos. Na página Qualidade, Mais ▾ → Nomes compostos… abre a lista do projeto de nomes que contêm "and" ou "or" mas nomeiam uma única coisa, um por linha (por exemplo "power and data connector"). O R19 não os sinaliza. As expansões do glossário de acrônimos do projeto (Statements de acrônimos, veja Encontrar acrônimos) também contam, e alguns nomes comuns são nativos ("command and control", "research and development", "operations and maintenance", …). A lista é salva com o projeto e pode ser desfeita. Clique em Checar qualidade de novo para aplicar uma mudança.
Requisitos em outros idiomas
O Holarch detecta o idioma de cada requisito a partir do texto. As regras de palavras (R2–R10, R16, R19, R20, R24, R26, R31–R35, "up to", o verbo modal, as unidades) pontuam requisitos em inglês.
Alemão, francês e espanhol (beta). Esses requisitos recebem as mesmas regras em seu próprio idioma, por exemplo "angemessen" ou "bei Bedarf" em alemão, "approprié" ou "si possible" em francês, "adecuado" ou "según corresponda" em espanhol. Enquanto as regras de um idioma estão em beta:
- cada constatação é uma sugestão marcada com (beta). Ela aparece em cinza com as outras notas e nunca reduz um critério nem a pontuação;
- a nota "As regras de redação deste idioma estão em beta: apenas sugestões, sem pontuação. As checagens de estrutura se aplicam." é mostrada, e Inequívoco fica – (não checado) até que a redação seja checada com IA ou avaliada manualmente;
- as palavras para “cada” (jede, chaque, cada) são a escolha certa e não são sinalizadas, nem "alle 5 s" ou "tous les 5 s" (a cada 5 s).
Uma regra só passa a contar para um idioma depois de medida em pelo menos 300 declarações escritas nesse idioma e revisada por um engenheiro de requisitos nativo (pelo menos 90 % das constatações corretas), e depois que o revisor a aprova. Quando isso acontece, as pontuações desse idioma podem mudar na próxima checagem; as notas de versão informam isso.
Outros idiomas (japonês, italiano, chinês e os demais) recebem:
- a nota "As regras de redação cobrem o inglês. As checagens de estrutura se aplicam." e – (não checado) para Inequívoco: fica fora da pontuação até que a redação seja checada ou avaliada manualmente. Outra constatação de Inequívoco, como um TBD, ainda o reprova;
- as checagens para qualquer idioma: R18 (também 。), o ponto final (também 。), R17, R21, TBD/TBR, R30, o nome, a descrição e o vínculo de verificação.
Todo idioma, em beta ou não, também recebe essas checagens. As sugestões são armazenadas em inglês com as palavras citadas como foram escritas ("R7 - Imprecise wording: [angemessen] (beta)"), para que o filtro quality:R7 e as exportações funcionem igual em todos os idiomas. A API pública as retorna com sua regra, palavras e modo (findings).
Checar redação com IA. ✦ IA ▾ → Checar redação com IA… na página Qualidade (ou ✦ Mais IA ▸ em um requisito) aplica as mesmas regras por meio da IA configurada, no idioma de cada requisito. A pré-visualização lista as constatações e uma reescrita opcional nesse idioma (desmarcada). Aplicar selecionados adiciona as constatações como constatações da IA e remove a nota (as sugestões beta continuam como notas), em uma etapa de desfazer. Editar o texto as limpa. Exige um plano com IA.
Substituições manuais
Substitua um critério quando discordar do resultado automático, ou para registrar a decisão de um revisor.
- Na página Qualidade: clique em uma célula de critério para alterná-la: o primeiro clique define um Sim manual (✔), o seguinte um Não manual (✘), e o terceiro limpa o valor manual para que a checagem automática decida de novo. Uma célula manual mostra um marcador de manual; sua dica diz "(definido manualmente)" e o que o próximo clique faz.
- No inspetor ou na Visão do item: cada critério é uma lista com Sim e Não. Um critério definido manualmente também oferece Automático (checar de novo), que o devolve ao resultado automático. Os valores definidos manualmente mostram "manual".
Um valor manual é mantido quando a checagem é executada de novo. Um Não manual sem outra mensagem mostra "Marcado como Não manualmente."
As substituições são limpas em dois casos:
- O nome ou a descrição do requisito muda. As substituições ficam no Histórico, e Desfazer as traz de volta.
- Você escolhe Mais ▾ → Limpar avaliações manuais. Isso também limpa as constatações da IA aceitas.
Resultados desatualizados
Quando o nome ou a descrição de um requisito muda depois de uma checagem, seus resultados são marcados como desatualizados:
- A página Qualidade mostra "Desatualizado — executar novamente" com a dica "O texto mudou depois da última checagem. Execute a checagem de qualidade de novo."
- A coluna Pontuação de qualidade de um documento mostra uma etiqueta Desatualizado com um ícone de relógio (aponte para ela para ver o motivo).
- O inspetor mostra "Qualidade: desatualizada — executar de novo".
Ative Checar novamente de forma automática quando o texto mudar para evitar resultados desatualizados. O Holarch então executa de novo a checagem de regras no requisito editado na hora. O ajuste é mantido neste navegador.
Checar a qualidade a partir de um documento
Em um documento, escolha Checar ▾ → Checar qualidade. Com um requisito selecionado, o item diz Checar a qualidade deste requisito e checa só esse. Sem requisito selecionado, ele checa todos os requisitos visíveis do documento.
Os resultados abrem no diálogo Checar qualidade — <name>, com os blocos e a tabela. Seus botões são Exportar CSV, Exportar XLSX, Abrir em Qualidade e Fechar.
Um documento sem requisitos mostra "Este documento não tem Requirements a checar. Statements não são pontuados."
Checagem de requisito por IA
Use a Checagem de requisito por IA para uma primeira opinião sobre os critérios que uma regra não consegue decidir: Correto, Viável e Necessário. Ela também procura redações que as regras deixam passar em Inequívoco (por exemplo "up to 72 hours" quando parece se tratar de um mínimo, ou "accurately" sem medida) e Verificável (nenhum teste, análise, inspeção ou demonstração poderia mostrar que o requisito é atendido como está escrito). A IA recebe as constatações das regras e relata apenas o que elas deixam passar.
- Escolha ✦ IA ▾ → Checar com IA (N requisitos)….
Para um único requisito, escolha Checar com IA (este requisito)… no menu ✦ IA ▾ dele, ou ✦ Mais IA ▸ → ✦ Checar com IA… no menu do botão direito.
O Claude revisa os requisitos. Eles são enviados em grupos de 20, com até 300 outros requisitos para a checagem de duplicatas. Na IA incluída, a checagem conta uma solicitação a cada 100 requisitos (arredondando para cima); antes de executar uma checagem de mais de 100 requisitos, um diálogo diz quantas ela usa, por exemplo "Esta revisão usa 3 das 52 solicitações de IA incluídas que restam neste mês (1 solicitação a cada 100 requisitos)." Uma checagem que precisa de mais solicitações do que as restantes não começa.
- Revise cada requisito no diálogo.
A linha no topo diz o que começa marcado: "Os itens marcados são aplicados. As reescritas começam desmarcadas para que você as leia primeiro. Requisitos bloqueados, aprovados e em linha de base começam desmarcados."
- Marque as mudanças e reescritas que você aceita.
A linha acima dos botões conta o que Aplicar faz, por exemplo "Aplica 7 valores e 2 reescritas a 5 requisitos." Sem nada marcado, ela diz "Nada selecionado." e Aplicar selecionados fica esmaecido.
- Clique em Aplicar selecionados.
Os itens marcados são aplicados, e um único Desfazer reverte tudo. A notificação diz "N mudanças da IA aplicadas".
Para cada requisito, o diálogo mostra:
- Um veredito Sim/Não e um motivo para Correto, Viável, Necessário, Inequívoco e Verificável.
- Abaixo de cada veredito, uma caixa de seleção rotulada com o que aplicá-lo muda, ou "sem mudança" sem caixa de seleção quando o valor armazenado já corresponde:
- Correto, Viável e Necessário: "Não → Sim" ou "Sim → Não" quando o veredito difere do valor armazenado, "Definir como Sim" ou "Definir como Não" quando não há nenhum.
- Inequívoco e Verificável: "Adiciona uma constatação" onde a IA encontrou um problema, e "Limpa a constatação anterior" onde uma constatação anterior da IA não vale mais.
- Um comentário opcional.
- Quando a IA propõe uma, uma caixa de seleção Aplicar a reescrita: com uma comparação palavra a palavra.
O que começa marcado:
- Toda mudança de valor começa marcada.
- As reescritas começam desmarcadas, para que você as leia primeiro.
- Requisitos aprovados, em linha de base e bloqueados começam desmarcados e são sinalizados.
Marcar uma reescrita esmaece as caixas de Inequívoco e Verificável desse requisito e as rotula como "Checado de novo após a reescrita": as checagens de regras são executadas de novo no novo texto. Desmarcar a reescrita restaura as caixas como estavam. Correto, Viável e Necessário continuam se aplicando.
| Botão | Efeito |
|---|---|
| Selecionar todas as mudanças de valor | Marca todas as mudanças de valor, exceto em requisitos aprovados, em linha de base e bloqueados. |
| Selecionar todas as reescritas | Marca todas as reescritas, exceto as sinalizadas. |
| Não selecionar nenhum | Desmarca tudo. |
O que Aplicar faz:
- Correto, Viável e Necessário viram valores manuais de Sim/Não.
- Um Não em Inequívoco ou Verificável vira uma constatação da IA: a página Qualidade a lista com as constatações das regras, como "IA: ambíguo — <reason>" ou "IA: não verificável como está escrito — <reason>", e o critério mostra ✘. Um Sim remove uma constatação anterior da IA.
- As constatações da IA são limpas quando o nome ou a descrição do requisito muda (também por uma reescrita aceita) e por Mais ▾ → Limpar avaliações manuais.
O que Aplicar selecionados faz:
- Os vereditos viram valores manuais, com a mensagem "IA: <reason>". Eles são mantidos quando a checagem é executada de novo.
- As reescritas substituem a descrição e executam a checagem de novo.
Exportações de qualidade
| Exportar | Conteúdo |
|---|---|
Exportar ▾ → CSV (quality_report.csv) | Uma linha por requisito e critério: Número, Nome, Descrição, Pontuação de qualidade, Atributo, Mensagem, Resultado. |
Exportar ▾ → Excel (.xlsx) (quality_report.xlsx) | Número, Nome, Descrição, Justificativa, Pontuação de qualidade, Atributo, Mensagem, Resultado, com as células do requisito mescladas nas nove linhas dele, Sim em verde e Não em vermelho, e uma Pontuação do relatório (respostas Sim sobre todas as respostas) no fim. |
| Entregar ▾ → Todas as exportações… → Constatações de qualidade (Excel) do documento | O mesmo layout para um único documento, com as colunas de exibição do documento. |
Aprovações
Use Necessidades e requisitos → Aprovações para ver tudo o que aguarda uma decisão. Ela abre o Banco de dados com a consulta Requirement:"Status=In Review".
Ela tem todos os recursos do Banco de dados:
- Selecione várias linhas e use a barra de ações em massa para definir Status ou rótulos em conjunto.
- Exporte a lista.
- Clique duas vezes em uma linha para a Visão do item e o histórico completo.
A caixa de aprovação
A caixa de aprovação aparece no inspetor e na Visão do item de todo requisito. Ela mostra:
- O status atual como um chip colorido (Rascunho quando nenhum está definido).
- A última decisão registrada: "<status> por <name> · <date and time>", seguida de "— <note>" quando há uma (por exemplo "— Texto alterado após a aprovação"), ou "Nenhuma aprovação registrada".
- Os botões que se aplicam ao status atual:
| Botão | Mostrado quando | Efeito |
|---|---|---|
| Aprovar | O Status não é Aprovado nem Rejeitado | Define Aprovado e registra você e a hora. Notificação: "Aprovado". |
| Rejeitar… | O Status não é Aprovado nem Rejeitado | Pede um Motivo (opcional) no diálogo Rejeitar requisito e depois define Rejeitado. Notificação: "Rejeitado". |
| Reabrir | O Status é Aprovado ou Rejeitado | Define Em revisão. Notificação: "Movido para Em revisão". |
O nome registrado é o nome da sua conta. Definir o Status manualmente em uma tabela ou no inspetor também registra uma decisão com o seu nome e a hora. Os leitores veem a caixa sem botões.
Quando um fluxo de trabalho envia a passagem para Aprovado por meio de uma solicitação de mudança, a caixa mostra a solicitação aberta e sua contagem, por exemplo CR-4: 1 de 3 aprovações. Depois de aplicada, a decisão nomeia todos os aprovadores e a solicitação: "Aprovado por Ann Lead, Bob Discipline · <date and time> · CR-4".
Nota: Editar o nome ou a descrição de um requisito Aprovado o define como Em revisão, com a nota "Texto alterado após a aprovação". A notificação informa "N requisito(s) aprovado(s) movido(s) para Em revisão." Alterar outros atributos não o reabre.
Registro de TBD/TBR
Use o registro para acompanhar cada item em aberto até ele ser fechado. Abra Necessidades e requisitos → TBD/TBR. A partir de um documento, escolha Checar ▾ → Registro de TBD/TBR para abrir o registro com o escopo desse documento.
- Cabeçalho da página: Exportar XLSX (desativado quando o registro está vazio).
- Barra de escopo: Escopo (Todos os requisitos ou Documento: <name>).
- Blocos: TBD/TBR em aberto, Atrasados, Sem responsável e chips Por documento ("<document>: <count>") que abrem cada documento.
- Itens abertos ao longo do tempo: um gráfico burn-down da contagem em aberto. Ele é reconstruído a partir do histórico dos requisitos, com até 60 pontos do requisito mais antigo até agora. Aponte para um ponto para ver a data e a contagem. Com histórico insuficiente, ele mostra "Ainda não há histórico suficiente para um burn-down."
- Colunas da Tabela:
- Número, e Nome com a descrição.
- Documento.
- Tipo: TBD, TBR ou TBS, com "atributo", "no texto" ou ambos.
- Responsável: o Responsável pelo TBD, senão o Responsável do requisito, senão "—".
- Prazo: o único prazo do requisito, a mesma data de Prazo no grupo Fluxo de trabalho do inspetor e na Visão do item. É o atributo Prazo do TBD quando ele contém uma data, senão o prazo do requisito. Mostra "Atrasado" abaixo de uma data passada. As linhas atrasadas ficam coloridas.
- Idade: dias desde que o item foi aberto.
- Fechar.
Clique com o botão direito em uma linha, ou pressione Shift+F10 nela, para o mesmo menu de linha do Banco de dados: ações sugeridas com seus motivos, ✦ Mais IA ▸, Abrir, Renomear…, Duplicar, Adicionar filho…, Status ▸, Prioridade ▸, Relacionar com ▸, Adicionar ao documento ▸, Mostrar no diagrama ▸, Copiar link, Copiar número e Excluir…. Em outros menus do botão direito, um requisito com um TBD ou TBR em aberto começa com Resolver TBD…, que abre este registro com o requisito selecionado.
O registro é somente leitura. Para mudar um prazo, selecione a linha e defina Prazo no inspetor. O Holarch define o prazo do requisito e, quando o atributo Prazo do TBD contém uma data, também esse atributo (mantendo a hora do dia), e um único Desfazer reverte tudo. Limpar Prazo limpa os dois.
Fechar só aparece quando o atributo TBD/TBR está definido. Ele define o atributo como None:
- Sem nada restante no texto, a notificação diz "Fechado".
- Com TBD, TBR ou TBS ainda no texto, a notificação diz "Atributo fechado; o texto ainda contém TBD."
- Um item só de texto não tem botão Fechar; edite o texto para fechá-lo.
Quando nada está em aberto, a página mostra "Nenhum item TBD/TBR em aberto. Defina o atributo TBD/TBR de um requisito, ou escreva TBD, TBR ou TBS no texto dele, para listá-lo aqui."
Exportar XLSX grava TBD-TBR Register.xlsx com Número, Nome, Documento, Tipo, Origem (atributo, texto ou ambos), Responsável, Prazo, Aberto em, Idade (dias), Atrasado (Sim em vermelho) e Descrição.
Vínculos a revisar
Use Vínculos a revisar (também chamados de vínculos suspeitos em outras ferramentas) para encontrar o que precisa ser checado de novo após a mudança de um requisito. Um vínculo precisa de revisão quando o item na outra extremidade mudou depois da última revisão do vínculo: confira se o vínculo ainda vale e marque-o como revisado. Necessidades e requisitos → Vínculos a revisar os lista. A partir de um documento, use Checar ▾ → Vínculos a revisar.
O que marca um vínculo para revisão
Estas mudanças em um requisito marcam seus vínculos para revisão:
- Nome ou Descrição.
- Prioridade, Criticidade, Método de verificação ou Nível de verificação.
- Qualquer atributo numérico, de porcentagem ou de duração.
O Holarch então marca cada vínculo do requisito destes tipos: decomposed by, derived by, refined by, satisfied by, verified by e traced to.
Uma mudança em Método de verificação ou Nível de verificação marca apenas os vínculos verified by. Definir o primeiro método ou nível de um requisito não marca nada: isso planeja a verificação e não muda nada que tenha sido revisado.
A outra extremidade de cada vínculo é o item a revisar: o requisito filho, a função ou o asset que o satisfaz, o caso de teste que o verifica e assim por diante. Novas mudanças no mesmo requisito se somam à lista de campos alterados na mesma marca.
Onde aparecem os vínculos a revisar
- Página Vínculos a revisar: uma linha por vínculo a revisar.
- Documentos e Banco de dados: um selo ⚠ Revisar na linha do item ("O item na outra extremidade mudou depois da última revisão deste vínculo. Confira se o vínculo ainda vale e marque-o como revisado. Clique para revisar.").
- Inspetor e Visão do item: um banner "⚠ Revisar: <requirement> mudou depois da última revisão deste vínculo. Confira se o vínculo ainda vale e marque-o como revisado." Seu botão Revisar… abre o diálogo Vínculos a revisar — <item> desse item, com Abrir Vínculos a revisar e Fechar.
- A seção Rastreabilidade do inspetor: um ⚠ ao lado de cada vínculo a revisar, com os campos alterados e a data na dica.
- RVTM: um ⚠ após um requisito com um vínculo a revisar em qualquer extremidade (ele mudou, ou o item a montante dele mudou); clique nele para revisar esses vínculos. Um ⚠ após um caso de teste em Verificado por marca esse vínculo de verificação.
A página Vínculos a revisar
A página explica a regra no topo e mostra uma tabela:
| Coluna | Conteúdo |
|---|---|
| (caixa de seleção) | Selecionar para Marcar selecionados como revisados…. A caixa de seleção do cabeçalho seleciona todos. |
| Alterado | O requisito que mudou. |
| Mudança | Os campos que mudaram, por exemplo "Descrição" ou "Prioridade, Nível de verificação". |
| Quando / Por | A data e a hora da mudança e quem a fez. |
| Relacionamento | O tipo de vínculo, lido a partir do requisito alterado (por exemplo "satisfied by"). |
| Item a revisar | O item na outra extremidade do vínculo. |
| (ações) | Diff e Marcar como revisado…. |
Clique com o botão direito em uma linha, ou pressione Shift+F10 nela, para o menu de linha do item, como no Banco de dados: ações sugeridas, ✦ Mais IA ▸, Abrir, Renomear…, Duplicar, Adicionar filho…, Status ▸, Prioridade ▸, Relacionar com ▸, Adicionar ao documento ▸, Mostrar no diagrama ▸, Copiar link, Copiar número e Excluir…. Em outros menus do botão direito (Banco de dados, documentos), um item com um vínculo a revisar começa com Revisar vínculo…, que abre a revisão dele.
Diff abre Alteração — <requirement> com uma comparação palavra a palavra do nome e da descrição. Quando só atributos mudaram, diz "Somente atributos mudaram: <fields>. Abra o histórico do item para ver os detalhes." Histórico… abre o histórico do requisito.
Para marcar vínculos como revisados:
- Clique em Marcar como revisado… em uma linha, Marcar selecionados como revisados… para as linhas marcadas, ou Marcar todos como revisados (N)….
Marcar N vínculo(s) como revisado(s) abre: "Confirme que os itens vinculados ainda são válidos após a alteração. Um comentário é adicionado a cada item vinculado."
- Digite um comentário opcional, por exemplo "Filho ainda válido; nenhuma mudança necessária."
- Clique em Marcar como revisado.
A notificação diz "N vínculos marcados como revisados."
Marcar selecionados como revisados… sem nada selecionado mostra "Selecione primeiro os vínculos a marcar como revisados."
Marcar um vínculo como revisado registra a revisão no vínculo: quem, quando, o comentário e os campos. Quando você escreveu um comentário, o Holarch também adiciona "Vínculo revisado (<requirement> mudou: <fields>): <comment>" aos comentários de cada item. Desfazer reverte isso.
Sem vínculos a revisar, a página mostra "Nenhum vínculo a revisar. Um vínculo precisa de revisão quando o item na outra extremidade muda depois da última revisão do vínculo."
Linhas de base e comparação de versões
Linhas de base de documentos
Crie e use linhas de base de documento com Versão ▾ no bloco de título do documento. Ele lista:
- Versão atual: o documento ativo.
- Cada linha de base deste documento, a mais recente primeiro, com sua data.
- Em Linhas de base do projeto, todas as linhas de base do projeto.
- Salvar linha de base… e Comparar versões… (esmaecido até o documento ter uma linha de base: "Salve uma linha de base primeiro").
Salvar linha de base… abre Salvar linha de base:
- Nome * (obrigatório).
- Aprovações: linhas de Nome, Função e Declaração, com + Adicionar aprovador. A primeira linha vem preenchida com o seu nome. "Nenhum aprovador." quando vazio.
- A nota "A linha de base guarda esta versão do documento (seus itens, os atributos e os relacionamentos deles) para visualizar, comparar e restaurar depois. Os registros de aprovação recebem a data de agora e não podem ser editados depois."
Escolha uma linha de base em Versão ▾ para visualizá-la. O documento fica somente leitura, com o banner "Linha de base “<name>”, somente leitura, salva em <date>" e a lista de aprovações. Estes botões aparecem:
| Botão | Efeito |
|---|---|
| Voltar à versão atual | Retorna ao documento ativo. |
| Editar | Editar linha de base: renomeá-la e adicionar registros de aprovação. Aprovações (bloqueadas) lista os registros existentes, que não podem mudar; os novos registros "recebem a data de agora e são adicionados à lista". Apenas linhas de base de documento. |
| Comparar com a versão atual | Abre Comparar versões a partir desta linha de base. Apenas linhas de base de documento. |
| Restaurar linha de base | Linha de base de documento: "Sobrescrever as entidades, a ordem e a estrutura deste documento com a linha de base "<name>"? As entidades adicionadas desde então são removidas do documento (não excluídas). Desfazer está disponível." Linha de base de projeto: Substituir projeto pela linha de base, "Substituir o projeto inteiro pela linha de base de projeto "<name>"? Desfazer está disponível." |
| Excluir | "Excluir a linha de base "<name>"?" |
No documento ativo, cada linha leva uma barra de mudança: nova desde a linha de base, alterada desde a linha de base, ou inalterada. A comparação é feita com a linha de base de documento mais recente, ou com a linha de base de projeto mais recente quando o documento não tem nenhuma.
Comparar versões
Use o relatório de mudanças para ver exatamente o que mudou desde uma revisão.
- Clique em Versão ▾ → Comparar versões…, ou em Comparar com a versão atual no banner de uma linha de base.
Comparar versões é aberto.
- Escolha De: uma linha de base.
- Escolha Para: uma linha de base posterior, ou Versão atual.
A tabela lista Número, Nome, Tipo de alteração, Campo e Alteração (uma comparação palavra a palavra para texto modificado).
Tipos de alteração:
| Tipo de alteração | Significado |
|---|---|
| Adicionado / Removido | A entidade entrou no documento ou saiu dele. |
| Modificado | Um campo mudou: Nome, Número, Descrição, Classe, Imagem ou qualquer atributo (o campo é nomeado). |
| Rótulo adicionado / Rótulo removido | Um rótulo foi adicionado ou removido. |
| Relacionamento adicionado / Relacionamento removido | Um vínculo que toca o documento foi adicionado ou removido. |
| Atributo de relacionamento | Os atributos de um relacionamento mudaram. |
Alterações (Excel) grava "<document> (Changes).xlsx" com Número, Nome, Classe, Tipo de alteração, Campo, Valor antigo e Valor novo. Redline (Word) grava a mesma comparação como alterações controladas do Word.
Entregar ▾ → Alterações (Excel)… do documento (também em Todas as exportações…) exporta o mesmo relatório com De e Para. Ele falha com "Este documento não tem linha de base. Salve uma primeiro." quando não há nenhuma.
Documento (Word) preenche as tabelas de Histórico de revisões e de Aprovações da saída Word a partir das linhas de base do documento.
Página Linhas de base e versões
Use Controle e revisões → Linhas de base e versões para gerenciar todas as linhas de base do projeto. As linhas de base de projeto contêm todas as entidades; as linhas de base de documento contêm um documento e são criadas com Versão ▾ → Salvar linha de base… do documento. O cabeçalho da página tem Restaurar uma versão anterior…, que traz de volta um salvamento automático anterior do projeto inteiro, e + Salvar linha de base….
Para criar uma linha de base de projeto:
- Clique em + Salvar linha de base… no cabeçalho da página.
O diálogo Salvar linha de base do projeto mostra as contagens atuais de entidades e relacionamentos. O nome padrão é "Baseline <n>"; o texto de exemplo diz "Nome, por exemplo "SRR"".
- Digite um nome e pressione Enter ou clique em Salvar linha de base. Um nome vazio é recusado ("Insira um nome.").
A notificação diz "Linha de base salva".
Os cartões da página:
- Cartão Linhas de base: as contagens atuais ("Atual: <n> itens, <n> relacionamentos") e um filtro: Todas as linhas de base, Linhas de base do projeto inteiro ou Documento: <name>. Colunas:
- Nome.
- Documento: um link para ver o documento nessa linha de base, ou "Projeto".
- Criada em.
- Aprovações: "✔" e os nomes dos aprovadores. Aponte para eles para ver função, data e declaração. "por <name>" nomeia quem a criou.
- Entidades e Relacionamentos.
- Comparar: define esta linha de base como De e a cópia de trabalho atual como Para.
- ⋯ (Mais ações):
- Renomear…: Renomear linha de base.
- Exportar (JSON): baixa "<name>.json" (formato
holarch-baseline, com o instantâneo e as aprovações). - Restaurar linha de base… (linha de base de projeto): "Substituir todas as entidades e relacionamentos atuais pela linha de base "<name>"? Desfazer está disponível (⌘Z / Ctrl+Z)." Notificação: ""<name>" restaurada".
- Reverter documento… (linha de base de documento): "Restaurar o documento "<doc>" para a linha de base "<name>"? Só as entidades e a estrutura desse documento mudam. Desfazer está disponível." Desativado quando o documento foi excluído.
- Excluir…. No serviço hospedado, só os proprietários do projeto renomeiam ou excluem uma linha de base; para os outros, esses itens ficam esmaecidos com o motivo.
- Linhas de base órfãs (mostrado quando necessário): "N linhas de base de documentos excluídos". Cada uma tem Restaurar documento, que recria o artefato do documento e suas entidades a partir da linha de base, e Excluir.
- Cartão Comparar: escolha De (mais antiga) e Para (mais recente). Para é Versão atual ou outra linha de base do mesmo escopo.
- Blocos: Entidades adicionadas, Entidades removidas, Entidades alteradas, Mudanças de relacionamento.
- A tabela mostra Entidade, Alteração, Campo e Diferença (comparação palavra a palavra). Os atributos de data aparecem no formato de data do aplicativo.
- Exportar CSV e Exportar XLSX gravam "Changes <from> to <to>".
- Sem nada a mostrar: "Nenhuma diferença entre “<from>” e “<to>”."
Sem linhas de base: "Nenhuma linha de base. Crie uma para registrar o estado atual do projeto."
Nota: As linhas de base são armazenadas no projeto e viajam com ele em uma exportação do projeto. Uma linha de base de projeto contém entidades e relacionamentos. Uma linha de base de documento também contém os ajustes de estrutura do documento.
Importar requisitos
Use Necessidades e requisitos → Importar e exportar para trazer requisitos de arquivos. Funciona em quatro passos: Arquivo → Mapear → Revisar → Importar.
- Voltar e Continuar passam de um passo a outro. Importar N itens, no passo Revisar, importa, e um único Desfazer reverte tudo.
- Uma única área de soltura aceita todos os formatos. O formato é detectado a partir do arquivo (seu nome e, quando isso não basta, seu conteúdo) e aparece em Formato, onde você pode alterá-lo.
Os formatos são Word (.docx), arquivos de projeto do Holarch (.holarch, .json), Excel / CSV (.xlsx, .csv), Texto simples (.txt), UML/SysML (.xmi, .uml, .mdzip) e ReqIF (.reqif).
Esta seção trata dos formatos de requisitos. Para arquivos de projeto, XMI e todas as outras importações e exportações, veja Importação e exportação.
Passo 1: Arquivo
Solte um arquivo em "Solte um arquivo aqui ou clique para escolher um", ou cole texto na caixa e clique em Analisar texto (CSV com linha de cabeçalho, XML ReqIF, XMI, JSON ou texto de documento).
| Opção | Valores | Efeito |
|---|---|---|
| Formato | Os seis formatos acima | Mostra o formato detectado. Escolha outro para ler o mesmo conteúdo de outra forma. |
| Codificação de texto (CSV, texto) | Automática, UTF-8, ISO-8859-1 / Windows-1252, Shift_JIS, Big5, UTF-16 | Como os bytes do arquivo são lidos. Alterá-la relê o arquivo. |
| Planilha (pastas de trabalho) | "<name> (N linhas)" | A planilha a importar. A primeira planilha com dados vem pré-selecionada. |
- Texto simples: a caixa mantém o conteúdo importado editável. Edite-o e clique em Executar a análise novamente.
- A linha de status diz "“<file>” analisado: N linhas, M colunas." (mais "(planilha “<name>”)" e, para Word, ", N tabela(s)").
Passo 2: Mapear
Cada coluna do arquivo é uma linha: Coluna do arquivo (título e posição), Valores de exemplo (as três primeiras linhas) e Campo do Holarch. Escolha Ignorar para deixar uma coluna de fora. Os campos correspondidos pelo título da coluna são marcados como auto.
| Campo do Holarch | Conteúdo |
|---|---|
| Nome, Número, Descrição | Os campos próprios do item. |
| Classe, Rótulos | O nome da classe; nomes de rótulos separados por ; , ou |. |
| Número do pai, ID global | O número do pai; o ID usado para corresponder entidades existentes. |
| Um atributo | Qualquer atributo da classe para linhas sem classe. |
| Um relacionamento | Separe vários destinos com ;. |
| ID da linha, ID da linha pai, Novo atributo (adicionado ao esquema) | Estrutura de arquivos ReqIF e XMI, e novos atributos. |
✦ IA ▾ → Sugerir mapeamento propõe um campo para cada coluna. Mapeamento sugerido lista as mudanças, marcadas, com o motivo da IA; Aplicar marcados altera o mapeamento. Nada é importado ainda.
O Holarch deduz o mapeamento a partir do cabeçalho:
| Cabeçalho | Mapeia para |
|---|---|
| Number, No, Num, #, ID Number, Req Number, Requirement Number | Número |
| Name, Title, Short Name, Requirement Name | Nome |
| Description, Text, Requirement, Requirement Text, Statement, Desc | Descrição |
| Class, Type, Entity Class | Classe |
| Labels, Label, Tags | Rótulos (separe os valores com ; , ou |) |
| Parent, Parent Number | Número do pai |
| Global ID, ID, GUID, UUID | ID global |
| Um nome de atributo (por exemplo Priority, Rationale, Status) | Esse atributo. "Method" e "Verification" mapeiam para Método de verificação. |
| Um nome de grupo de rótulos (por exemplo Verification Method quando não existe esse atributo) | Rótulos |
| Um nome de relacionamento (por exemplo satisfied by) | Esse relacionamento; separe vários destinos com ; |
| Object Identifier, Origin ID | ID global |
| Object Number, ReqIF.ChapterName, ReqIF.ForeignID | Número |
| Object Heading, ReqIF.Name, Long Name | Nome |
| Object Text, ReqIF.Text, ReqIF.Description | Descrição |
| ReqIF.Category | Classe |
| ReqIF ID, XMI ID, Row ID / Parent ID | ID da linha / ID da linha pai |
Novo atributo cria um atributo com o nome da coluna, em cada classe importada. Seu tipo segue os valores:
- Número, quando todos os valores são números.
- Uma lista de opções, quando há poucos valores distintos e curtos.
- Texto longo, para valores com mais de 120 caracteres.
- Texto nos demais casos.
Critérios de qualidade e atributos calculados e de arquivo não podem ser mapeados.
Abaixo das colunas:
| Opção | Valores | Efeito |
|---|---|---|
| Classe para linhas sem classe | Qualquer classe; padrão Requirement | A classe das linhas sem valor na coluna Classe e sem regra de classe correspondente. |
| Regras de classe | A descrição contém uma palavra ou expressão → uma classe | + Regra adiciona uma, × a remove. A primeira regra correspondente se aplica às linhas sem valor de Classe. |
| Corresponder entidades existentes por | ID global, Nome, Número | As linhas que correspondem a uma entidade existente a atualizam em vez de criar uma cópia. As correspondências por Nome e por Número também exigem a mesma classe. |
| Corresponder entidades relacionadas por | ID global, Nome, Número | Como os valores das colunas de relacionamento encontram seus destinos. |
| Formato das colunas de data (CSV) | Automático, yyyy-MM-dd HH:mm:ss, dd/MM/yyyy, MM/dd/yyyy, yyyyMMdd, Personalizado… | Como as células de data são lidas. Personalizado… mostra um campo para o seu próprio padrão (por exemplo dd.MM.yyyy HH:mm) usando yyyy, MM, dd, HH, mm e ss. |
| Padrão de numeração (Word, texto) | Vazio (automático), ou marcadores como 1. a) (i), ou números de caminho como 1.1 ou 1.1.a | Como os parágrafos numerados viram a estrutura. Para texto, o padrão é detectado a partir da numeração e preenchido. Os estilos de título e a numeração de listas do Word não precisam de padrão. Veja Padrão de numeração. |
| Numerar os filhos sob o pai (1 → 1.1) (Word, texto) | Ativado por padrão | Os números de filhos gerados viram "3.1", "3.2" em vez de "1", "2". |
Hierarquia. Os números da estrutura reconstroem a hierarquia: "1.2.3" vira filho de "1.2". Uma coluna Número do pai, ou um par ID da linha e ID da linha pai, define o pai explicitamente. Os itens sem pai viram itens de nível superior do documento.
Tabelas do Word. Para um arquivo Word, a seção Tabelas do Word lista cada tabela. As tabelas que se repetem com o mesmo cabeçalho em várias seções compartilham um único mapeamento. A seção explica: "Importe uma tabela de requisitos como entidades, uma por linha, e mapeie suas colunas. As outras tabelas continuam como tabelas na descrição do item que elas seguem."
- Defina cada tabela como Entidades (uma por linha) ou Tabela na descrição.
- Mapeie suas colunas para Número, Nome, Descrição, Classe, Rótulos, Atributo, Novo atributo ou Ignorar.
- Cabeçalhos como ID, Req ID, Requirement ID, Ref ou Paragraph mapeiam para Número.
- Shall, Shall Statement, Requirement Statement, Requirement Text, Statement ou Text mapeiam para Descrição.
Uma tabela com uma coluna de número ou de descrição e linhas com "shall" começa como entidades.
Os avisos encontrados até agora aparecem abaixo das colunas, ou "Nenhum aviso."
Passo 3: Revisar
Confira o resultado antes que algo mude. Revisar mostra as mudanças do mesmo jeito que Linhas de base e versões compara versões (veja Linhas de base e comparação de versões):
- A primeira linha nomeia o arquivo, o formato e a contagem de itens por classe.
- Criar um documento de requisitos a partir destes N requisitos aparece, marcado, quando todo item é um Statement ou Requirement (ou uma subclasse). Para outros arquivos, diz Criar um documento a partir destes N itens, desmarcado. Marcado, escolha o Tipo de documento (padrão Documento de requisitos), o Nome (padrão: o nome do arquivo) e se deseja Renumerar o documento inteiro após a importação.
- Os avisos vêm em seguida.
- Os blocos contam os Novos itens, os Itens atualizados, os itens Associado, sem alteração e os Relacionamentos do arquivo.
- A tabela de mudanças lista cada item novo com sua descrição, e cada campo alterado de um item atualizado com uma comparação palavra a palavra do valor antigo e do novo (as primeiras 500 mudanças).
Clique em Importar N itens. A notificação diz "N novos importados, M atualizados".
- Sem avisos, o Holarch abre o novo documento de requisitos (ou o Banco de dados).
- Caso contrário, o cartão Importação concluída lista os avisos ("A importação não relatou avisos." quando não há nenhum). Seus botões são Abrir documento, Abrir Banco de dados, Diagrama Spider, Diagrama de árvore, Checar qualidade e Iniciar outra importação.
A descrição do novo documento lista os avisos da importação.
Como cada formato é lido
Word (.docx):
- Os títulos e a numeração de listas do Word viram a estrutura e mantêm seus números.
- Um título vira um Statement. O texto do corpo abaixo dele vira sua descrição.
- Um parágrafo com shall, must, will ou should vira um Requirement filho, nomeado a partir das palavras após o verbo modal. Um item de lista numerada também; sem verbo modal, ele vira um Statement.
- Itens com marcadores, imagens e tabelas entram na descrição do item que eles seguem, mantendo negrito, itálico, listas e tabelas.
- O .docx original é anexado ao novo documento quando está dentro do limite de anexo por arquivo.
- As imagens PNG, JPEG, GIF, WebP e SVG são mantidas. Outros formatos de imagem são ignorados com um aviso.
Excel (.xlsx, .xlsm) e CSV:
- Uma linha por entidade, quaisquer colunas. A primeira linha é o cabeçalho.
- As células com várias linhas mantêm suas quebras de linha.
- Arquivos do Excel 97-2003 (.xls) não são lidos. Salve-os como .xlsx ou .csv primeiro.
ReqIF (.reqif, .reqifz):
- Cada SPEC-OBJECT vira uma linha com ReqIF ID, Parent ID (da hierarquia da especificação), Tipo (seu tipo de objeto, mapeado para Classe), Long Name e uma coluna por definição de atributo.
- As colunas sem correspondência ficam por padrão como Novo atributo. Os atributos XHTML viram atributos de texto formatado, e os atributos de enumeração viram listas de opções.
- As SPEC-RELATIONs viram relacionamentos pelo nome. Quando o nome não corresponde a um relacionamento permitido pelo esquema, elas viram traced to.
- Um arquivo .reqifz é descompactado automaticamente.
Texto simples (.txt) ou texto colado:
- Uma linha numerada ("3.1 Battery"), ou uma linha curta sem ponto final, vira um título (Statement).
- Cada frase com shall, must, will ou should vira um Requirement sob o título atual.
- O restante do texto entra na descrição do item anterior.
- Com um padrão de numeração (detectado a partir do texto, ou digitado), o padrão decide os níveis.
Atualizar requisitos a partir de uma planilha
Use isto para alterar muitos requisitos de uma vez em uma planilha.
- No Banco de dados (ou na página Requisitos), clique em Exportar… e escolha Tabela (CSV).
- Marque os atributos a editar. Em Incluir, marque ID e clique em Exportar.
- Edite os valores na planilha. Não altere a coluna ID.
- Importe o arquivo. Em Mapear, confira se a coluna ID mapeia para ID global e defina Corresponder entidades existentes por como ID global.
- Em Revisar, desmarque Criar um documento….
As linhas correspondidas contam como Itens atualizados, com cada campo alterado listado.
- Clique em Importar N itens.
Um valor I_… de um arquivo exportado antes desta versão não corresponde; use a coluna ID. Para todos os passos e opções, veja Importação e exportação.
O que uma atualização grava:
- Apenas as colunas mapeadas. Uma coluna Descrição ausente mantém cada descrição existente.
- Os rótulos do arquivo são adicionados aos rótulos existentes.
- Sem uma coluna Classe, uma linha correspondida pelo ID global mantém a classe da sua entidade.
Mensagens da importação
| Mensagem | Significado e correção |
|---|---|
| Nenhuma coluna mapeia para Nome ou Número. Mapeie uma delas. | Mapeie pelo menos uma coluna para Nome ou Número. |
| Linha N: classe desconhecida "X", usando <class>. | O valor de Classe não corresponde a nenhuma classe. Corrija o valor ou mapeie a coluna para Ignorar. |
| Linha N: rótulo desconhecido "X" ignorado. | Crie o rótulo no esquema primeiro, ou corrija o valor. |
| Linha N: "<attribute>" não se aplica à classe <class>. | A classe da linha não tem esse atributo. |
| Linha N: "<value>" não é um <type> válido para "<attribute>". | O valor não pode ser lido como número, data, opção e assim por diante. Confira a opção de formato de data. |
| Linha N: o Nome tem mais de 255 caracteres e foi encurtado. / Linha N: o Número tem mais de 255 caracteres e foi encurtado. | Nomes e números são limitados a 255 caracteres. |
| Número duplicado X (linhas A e B). | Duas linhas compartilham um número; a hierarquia pode anexar os filhos à primeira. |
| Linha N: número do pai P ausente para X; anexado a Q. / …; importado no nível superior. | O número do pai direto não está no arquivo. |
| Linha N: número do pai P não encontrado. / Linha N: pai P não encontrado. | O Número do pai ou o ID da linha pai se refere a uma linha que não está no arquivo. |
| Linha N: destino "X" de "<relationship>" não encontrado. | A coluna de relacionamento nomeia uma entidade que não existe. Confira Corresponder entidades relacionadas por. |
| Linha N: "<relationship>" de A para B não é permitido pelo esquema (criado mesmo assim). | O vínculo foi criado, embora o esquema não o liste. |
| O relacionamento "X" entre A e B não é permitido pelo esquema; ignorado. | Não foi possível criar uma relação ReqIF ou XMI, nem mesmo como traced to. |
| Imagem X: imagens .ext não são compatíveis e foram ignoradas. Salve a imagem como PNG ou JPEG no Word para mantê-la. | Imagem do Word em um formato não compatível. |
| A imagem X (tamanho) excede o limite de anexos de <limit> e foi ignorada. | A imagem é maior que o limite por arquivo. |
| Nenhuma linha de dados foi encontrada. | O arquivo ou a planilha tem apenas um cabeçalho, ou está vazio. |
| Não foi possível ler o arquivo: arquivos do Excel 97-2003 (.xls) não são compatíveis. No Excel, salve o arquivo como .xlsx ou .csv e importe-o de novo | Converta o arquivo. |
| Não foi possível ler o arquivo: XML com declaração DOCTYPE ou ENTITY não é aceito. Salve o arquivo sem ela e importe-o de novo | Remova a declaração do arquivo ReqIF ou XML. |
| Não foi possível ler o arquivo: XML inválido | O arquivo ReqIF não é um XML bem formado. |
| Falha na importação: <reason> | A importação parou; nada foi alterado. |
Atalhos dos requisitos
| Teclas | Onde | Ação |
|---|---|---|
| Enter | Entrada rápida no documento | Adicionar o requisito digitado. |
| ⌘ / Ctrl+Enter / ⌥ / Alt+⌘ / Ctrl+Enter | Documento, item selecionado | Adicionar um irmão / um filho. |
| Enter ou Space | Linhas de Qualidade, TBD/TBR e Vínculos a revisar | Mostrar no inspetor o requisito ou o item a revisar da linha. |
| ↑ / ↓ | Mesmas linhas, linha com foco | Ir para a linha anterior ou seguinte. |
| ⌘ / Ctrl-clique, ⇧ / Shift-clique, ⌘ / Ctrl+⇧ / Shift-clique | Linhas de Qualidade, TBD/TBR e Vínculos a revisar; linhas do Banco de dados; itens de documento | Alternar uma linha, selecionar o intervalo a partir da última linha clicada, adicionar esse intervalo. |
| ⌘A / Ctrl+A, ⇧ / Shift+↑ / ⇧ / Shift+↓ | Mesmas linhas, linha com foco | Selecionar todas as linhas mostradas; estender a seleção a partir da linha com foco. |
| Clique com o botão direito, Shift+F10 ou a tecla Menu | Linhas de Requisitos, Qualidade, TBD/TBR e Vínculos a revisar; itens de documento e entradas da Estrutura | Abrir o menu da linha: primeiro as ações sugeridas com seus motivos e ✦ Mais IA ▸, depois os comandos do item. |
| Esc | Qualidade, TBD/TBR, Vínculos a revisar, RVTM | Desmarcar a linha. |
| Enter | Campo de nome de Linhas de base e versões | Criar a linha de base do projeto. |
| ⌘Z / Ctrl+Z | Em qualquer lugar | Desfazer a última mudança, incluindo uma importação inteira, a marcação de vínculos como revisados ou uma mudança de status. |
Para todos os atalhos do aplicativo, veja Atalhos de teclado.
Ajustes
| Ajuste | Onde | Padrão | Escopo |
|---|---|---|---|
| Checar novamente de forma automática quando o texto mudar | Barra de escopo da página Qualidade | Desativado | Este navegador |
| Grupos do inspetor recolhidos ou abertos (Qualidade e os outros) | Clique no título de um grupo no inspetor, ou em Recolher tudo / Expandir tudo no fim dos links dele | Qualidade recolhido, o resto aberto | Este navegador, por classe |
| Seu nome em aprovações, decisões e comentários | O nome da sua conta | — | Conta |
| Status de rastreamento (pontos nos requisitos) | Exibir ▾ do documento | Em | Documento |
Mensagens
| Mensagem | Onde | Significado |
|---|---|---|
| N requisitos checados | Qualidade | A checagem foi executada no escopo. |
| Nenhum requisito neste escopo. | Qualidade | O escopo não tem requisitos. |
| Este documento não tem Requirements a checar. Statements não são pontuados. | Checar qualidade do documento | Mude os itens para Requirement ou cheque outro documento. |
| Desatualizado — executar novamente / Desatualizado / Qualidade: desatualizada — executar de novo | Qualidade, documentos, inspetor | O texto mudou depois da última checagem. |
| Requer o julgamento de um revisor | Qualidade (Correto, Viável) | Uma pessoa precisa decidir; clique em ✘ para marcar Sim. |
| Marcado como Não manualmente. | Qualidade | Um revisor definiu o critério como Não. |
| N requisito(s) aprovado(s) movido(s) para Em revisão; N vínculo(s) marcado(s) para revisão. | Após uma edição | A edição reabriu aprovações e marcou vínculos para revisão. |
| Aprovado / Rejeitado / Movido para Em revisão | Caixa de aprovação | A decisão foi registrada. |
| N vínculos marcados como revisados. | Vínculos a revisar | As revisões foram registradas. |
| Selecione primeiro os vínculos a marcar como revisados. | Vínculos a revisar | Marque linhas antes de Marcar selecionados como revisados…. |
| Fechado / Atributo fechado; o texto ainda contém TBD. | TBD/TBR | O atributo foi definido como None. |
| O texto ainda contém TBD. Edite o texto para fechá-lo. | TBD/TBR | Mostrado ao fechar um item só de texto. |
| Linha de base salva | Documentos, Linhas de base e versões | O instantâneo foi salvo. |
| Este documento não tem linha de base. Salve uma primeiro. | Comparar com a versão atual, relatórios de mudanças | O documento não tem linha de base. |
| Revertido para "<name>" / "<name>" restaurada | Linhas de base | O documento ou o projeto foi revertido; Desfazer está disponível. |
| Nenhum requisito a revisar. Selecione ou abra requisitos primeiro. | Checagem de requisito por IA | Nenhum requisito no escopo. |
Limites
- Checar qualidade: cada requisito do escopo é comparado com os outros em busca de duplicatas (limiar de similaridade de 75%).
- Checagem de requisito por IA: 20 requisitos por solicitação de IA, com até 300 outros requisitos como contexto.
- A comparação da revisão de vínculos guarda os primeiros 500 caracteres do nome antigo e 4.000 da descrição antiga.
- Burn-down de TBD/TBR: até 60 pontos.
- Importação:
- Nomes e números com até 255 caracteres.
- A pré-visualização mostra as primeiras 500 linhas. Os primeiros 50 avisos são listados ("…e mais N").
- Um padrão de numeração tem no máximo 6 níveis ("O padrão de numeração tem mais de 6 níveis. Use no máximo 6 marcadores.").
- Arquivos ReqIF/XML de até 100 milhões de caracteres e 3.000.000 de elementos.
- Arquivos .reqifz e .docx de até 10.000 entradas, 300 MB por entrada e 600 MB no total.
- As imagens e o arquivo Word original são mantidos apenas dentro do limite de anexo por arquivo (10 MB no plano Free, 25 MB no Individual, 100 MB no Team).
Relacionado
- Documentos: escrever e estruturar especificações, relatórios e saída DOCX.
- Rastreabilidade: relacionamentos, a Matriz de rastreabilidade, cobertura e impacto.
- O modelo e o banco de dados: consultas, colunas e edição em massa.
- Extensões de esquema: adicionar atributos, opções e rótulos de requisito.
- Importação e exportação: todos os formatos de arquivo.
- Ajuda: Requisitos, status e aprovação, Qualidade dos requisitos, Registro de TBD/TBR, Vínculos a revisar, Aprovações, Importação, Linhas de base e versões, RVTM.