Holarch

Requisitos

Geração de documentos

Insira matrizes vivas de rastreabilidade, verificação e interfaces e relatórios de teste em documentos, exporte-os em quatro formatos, gere-os a partir de uma linha de base e aplique marcações: um aviso da empresa, uma declaração de distribuição do DoD, um aviso de controle de exportação, um copyright ou um número de contrato em cada página e exportação.

Como usá-lo →

Nesta página
  1. Visão geral
  2. Conceitos
    1. As matrizes
    2. Dinâmicas, não copiadas
  3. Como usá-lo
    1. Inserir uma matriz em um documento
    2. Exportar uma matriz
    3. Matrizes a partir de uma linha de base
    4. Relatórios de teste
    5. Marcar documentos e exportações
    6. Definir a marcação do projeto
    7. Definir a marcação da organização
    8. Dar a um documento sua própria marcação, uma capa e números de página
    9. Onde as marcações são impressas
  4. Checagens do modelo
  5. Dicas

Visão geral

O Holarch gera entregáveis a partir do modelo, então um documento sempre corresponde aos requisitos, testes e vínculos por trás dele. Três ferramentas cobrem o que os revisores costumam pedir:

  • Blocos de matriz: uma matriz de rastreabilidade, de verificação ou de interfaces, ou um relatório de teste, dentro do texto de um documento, atualizada sempre que o modelo muda.
  • Exportar matriz: as mesmas matrizes e o Relatório de teste como arquivo próprio em Excel, Word, CSV ou página web, a partir do modelo atual ou de uma linha de base.
  • Marcações e Configurar página: uma marcação para a organização, o projeto ou um documento (um aviso da empresa, uma declaração de distribuição, um aviso de controle de exportação, um copyright ou um número de contrato) em todas as exportações, além de uma capa e números de página para o Word.

Os valores e as tabelas dinâmicos no texto são tratados na página Documentos: Valor dinâmico… insere um atributo de uma entidade, Contagem ou total… um número calculado a partir de uma consulta, Tabela dinâmica… uma tabela a partir de uma consulta, e Referência cruzada… o número atual de uma seção, figura ou tabela.

Conceitos

As matrizes

MatrizLinhasColunasDestacado como lacuna
RTM (Matriz de rastreabilidade de requisitos)RequisitosNúmero, Requisito, Pai, Rastreado de, Rastreado para, Satisfeito porUm requisito sem pai e sem nada de onde seja rastreado
Matriz de desdobramento de requisitosRequisitosNúmero, Requisito, Desdobrado de, Desdobrado para, Requisitos derivadosUm requisito de nível superior sem filho e sem requisito derivado
Matriz de alocação de requisitosRequisitosNúmero, Requisito, Componentes, Funções, OutrosUm requisito que nada satisfaz
Matriz de conformidade (mostrada quando o programa formal está ativado)Requisitos de uma especificação do clienteNúmero, Requisito, Conformidade, Resposta, Nossos requisitos e projeto, Verificação, Desvio/DispensaUm requisito sem declaração de conformidade (Não avaliado)
RVTM (Matriz de rastreabilidade da verificação de requisitos)RequisitosNúmero, Requisito, Método, Nível, Verificado por, StatusSem método de verificação ou sem caso de teste que verifique
VCRM (Matriz de referência cruzada de verificação)RequisitosNúmero, Requisito, Inspeção, Análise, Demonstração, Teste, Verificado por, StatusNenhum método de verificação escolhido
VCRM por nível de verificaçãoRequisitosNúmero, Requisito, depois I, A, R e T sob cada nível de verificação, Verificado por, StatusSem método de verificação ou sem nível de verificação
Relatório de testeCasos de teste de um ciclo de testeNúmero, Caso de teste, Verifica, Status, Resultado real, ExecuçãoUm caso de teste que não passou no ciclo
Matriz de alocaçãoFunções (Actions)Número, Função, Executada porUma função que nenhum componente executa
Matriz de interfacesComponentes (Assets)Os mesmos componentes; uma célula lista os Conduits do componente da linha para o componente da colunaUm componente sem Conduit de ou para os outros
Matriz N²Funções (Actions)As mesmas funções; uma célula lista os Input/Outputs que a função da linha gera e que a função da coluna recebeUma função que não troca nenhuma entrada ou saída
Matriz personalizadaEntidades de uma consulta de pesquisaEntidades de uma segunda consulta; uma célula nomeia os relacionamentos entre as duas, ou mostra X para um relacionamento escolhidoUma linha sem relacionamento com nenhuma coluna
  • Pai é o requisito que a linha decompõe. Rastreado de, Rastreado para e Satisfeito por listam as entidades relacionadas. Na matriz de desdobramento, Requisitos derivados são os requisitos para os quais a linha é rastreada.
  • Na VCRM, um X marca cada método planejado; Status é o resultado da verificação até agora, consolidado a partir dos casos de teste como na Central de testes.
  • Na VCRM por nível de verificação, as colunas são agrupadas pelos níveis do atributo Nível de verificação (Componente, Subsistema, Sistema). Um X fica sob o nível do requisito e cada um dos seus métodos planejados.
  • Os casos de teste nunca são listados como funções: as matrizes de alocação e N² mostram as Actions que não são Test Cases.
  • Escopo: uma matriz cobre as entidades de um documento (na ordem e na numeração do documento), todas as partes de uma compilação ou o projeto inteiro. A matriz de alocação usa as funções do documento, ou todas as funções quando o documento não tem nenhuma. As matrizes de interfaces e N² também podem cobrir os filhos de um Asset ou de uma Action, como fazem os diagramas I² e N²; para o projeto inteiro, elas listam os componentes ou as funções que têm um Conduit ou um Input/Output, até 120. A matriz personalizada mostra até 2.000 linhas e 120 colunas.
  • O bloco Relatório de teste mostra um ciclo de teste de uma suíte de testes, ou os resultados atuais dela. Veja Relatórios de teste.

Dinâmicas, não copiadas

Um bloco de matriz guarda apenas o que mostrar, não as linhas. Toda vez que o documento é exibido ou exportado, o Holarch reconstrói as linhas a partir do modelo. O resultado fica em cache até a próxima alteração, então projetos grandes continuam rápidos.

Como usá-lo

Inserir uma matriz em um documento

  1. Abra o documento e clique na descrição do documento ou de um item.
  2. Na barra de ferramentas de texto formatado, abra + e escolha Matriz….
  3. Escolha a Matriz e o Escopo. O escopo começa no documento aberto.
    • Para uma Matriz personalizada, digite as consultas de pesquisa de Linhas e Colunas (por exemplo class:Requirement e class:Asset), escolha um Relacionamento ou mantenha Qualquer relacionamento, e dê a ela um Título, se quiser.
    • Para um Relatório de teste, escolha a Suíte de testes e o Ciclo de teste, ou Resultados atuais.

      Você vê uma pré-visualização. Ela é atualizada sempre que o modelo muda.

  4. Clique em Inserir.

    A matriz aparece no texto com um contorno tracejado. A legenda dela nomeia a matriz, o escopo e quantas linhas têm lacunas.

A matriz não pode ser editada célula por célula; altere o modelo. Para removê-la, exclua a tabela no editor como qualquer outro conteúdo.

Exportar uma matriz

  1. Em um documento, abra Entregar ▾ e escolha Matriz de rastreabilidade…. Ou escolha Entregar ▾ → Todas as exportações… e selecione Matriz de rastreabilidade (Excel), (Word), (CSV) ou (HTML).
  2. Em Exportar matriz, escolha a Matriz e o Escopo e, em Exportar como, escolha Matriz (Excel), Matriz (Word), Matriz (CSV) ou Matriz (HTML).
  3. Opcional: em Modelo, escolha uma linha de base em vez de Modelo atual. A lista mostra as linhas de base do projeto e as do documento escolhido.

    A linha sob os campos dá a contagem de linhas e o número de linhas com lacunas.

  4. Clique em Exportar.

    O aviso diz "Matriz exportada." As lacunas são sombreadas em vermelho no Excel, no Word e na página web. As exportações Word e página web usam o Configurar página do documento. No Word, as colunas de texto são largas e as colunas de método de verificação são estreitas, com os cabeçalhos I, A, R e T e uma legenda sob a tabela (I = Inspeção, A = Análise, R = Demonstração, T = Teste). Matrizes com mais de cinco colunas usam página em paisagem. A VCRM por nível tem uma segunda linha de cabeçalho com os níveis; as matrizes de interfaces, N² e personalizadas sombreiam os cabeçalhos de linha e a diagonal.

Matrizes a partir de uma linha de base

Um entregável assinado deve mostrar o modelo como estava na linha de base, não como está hoje. Uma matriz gerada a partir de uma linha de base usa as entidades e os relacionamentos da linha de base, e o título dela termina com "(linha de base nome)".

  • Exportar matriz: escolha a linha de base em Modelo.
  • Uma linha de base do projeto contém o modelo inteiro, então todas as matrizes funcionam a partir dela.
  • Uma linha de base do documento contém o documento, seus itens e as entidades vinculadas a eles. As matrizes desse documento ficam completas. Uma matriz que vai além do documento (o projeto inteiro, ou uma matriz de interfaces ou N²) leva a nota "Gerada a partir de uma linha de base do documento, que contém apenas esse documento e as entidades vinculadas a ele."

Relatórios de teste

Um relatório de teste dá os resultados de um ciclo de teste: o que foi testado, em qual configuração, o que passou e o que falhou, e quais requisitos isso verifica.

  1. Na Central de testes, registre um ciclo de teste com Iniciar novo ciclo…. Digite a Configuração / build e o Artigo de teste (ambos começam com os valores mais registrados na execução).
  2. No cartão da suíte, abra ⋯ e escolha Relatório de teste…. Ou abra ⋯ → Ciclos de teste… e clique em Relatório… em um ciclo.
  3. Em Exportar relatório de teste, escolha o Ciclo de teste e, em Exportar como, Relatório de teste (Word), (Excel), (CSV) ou (HTML), e depois clique em Exportar.

O relatório Word (o padrão) tem estas seções:

  1. Identificação: suíte de testes, ciclo de teste, quando os resultados foram salvos e quando o relatório foi feito.
  2. Ambiente de teste e configuração: configuração ou build, artigo de teste, testadores e datas de execução.
  3. Resumo dos resultados: contagens por status e a taxa de aprovação.
  4. Resultados por caso de teste: uma linha por caso de teste.
  5. Resultados detalhados: por caso de teste, o resultado esperado e o real, testador, data, configuração, artigo de teste, arquivo de evidência e os resultados das etapas.
  6. Desvios e problemas em aberto: casos de teste reprovados e bloqueados com os Issues vinculados.
  7. Evidências de teste: os arquivos de evidência registrados no ciclo.
  8. Status da verificação de requisitos: os requisitos que a suíte verifica, com o status deles a partir dos resultados deste ciclo.

O Excel dá três planilhas (Resultados, Etapas, Requisitos); CSV e a página web dão a tabela de resultados. Os resultados vêm do ciclo como foi salvo, então o relatório continua o mesmo depois que a suíte é redefinida. Nomes, requisitos verificados e Issues vêm do modelo atual. Ciclos salvos antes de os resultados das etapas e as evidências serem guardados mostram esses campos como "—".

Para colocar a tabela de resultados em um documento, insira um bloco de matriz Relatório de teste (veja acima).

Marcar documentos e exportações

Uma marcação é um texto que o Holarch imprime em tudo o que você exporta: um cabeçalho no topo de cada página, um rodapé na base de cada página e um aviso na primeira página. Defina-a uma vez para o projeto, ou para a organização, e todas as exportações a levam. Um documento pode substituí-la pela sua própria.

Nota: O serviço hospedado (app.holarch.app) não pode conter CUI, informações classificadas ou controladas para exportação (Termos de Uso). Ali, a lista padrão deixa de fora as Distribution Statements B a F e o aviso de controle de exportação, e uma marcação que cite CUI, um nível de classificação (como SECRET//NOFORN), ITAR, EAR ou controle de exportação, ou as Distribution Statements B a F, não é salva: "O serviço hospedado do Holarch não pode conter CUI, informações classificadas ou controladas para exportação, então esta marcação não pode ser usada aqui. Remova-a, ou use o app desktop ou uma instalação auto-hospedada." Avisos da empresa como Company Confidential, Distribution Statement A, copyright e números de contrato continuam disponíveis. As marcações definidas antes desta regra são mantidas e continuam sendo impressas; para alterar uma, remova a parte restrita.

O app desktop e as instalações auto-hospedadas oferecem a lista completa e aceitam qualquer marcação. As marcações são textos que você escolhe; o Holarch as imprime, mas não impõe regras de manuseio, e valem os controles da sua própria organização. Em todas as edições, um aviso de controle de exportação em uma marcação desativa a IA no projeto.

A lista Marcação padrão preenche o texto para você:

Marcação padrãoCabeçalhoRodapéAviso
Company ProprietaryCOMPANY PROPRIETARYCOMPANY PROPRIETARYUm aviso de propriedade que nomeia a Empresa
Company ConfidentialCOMPANY CONFIDENTIALCOMPANY CONFIDENTIALUm aviso de confidencialidade que nomeia a Empresa
Distribution Statement A a F (B a F: somente no app desktop e auto-hospedado)(nenhum)DISTRIBUTION STATEMENT A a FO texto padrão do DoD para a declaração (DoDI 5230.24), com Motivo, Data da determinação e Escritório controlador preenchidos
Aviso de controle de exportação (ITAR/EAR) (somente no app desktop e auto-hospedado)(nenhum)Export-controlled technical data. See the notice on the first page.Um aviso de que o documento pode conter dados técnicos sob o ITAR (22 CFR 120–130) ou o EAR (15 CFR 730–774)
Copyright(nenhum)© Ano Titular dos direitos autorais. All rights reserved.(nenhum)
Número do contrato(nenhum)Contract No. Número do contrato(nenhum)

Um campo que você deixar vazio permanece no texto como um marcador entre colchetes, como [reason]. O editor então mostra "Complete as partes entre colchetes antes de exportar."

Definir a marcação do projeto

  1. Pressione ⌘K / Ctrl+K e escolha Marcação do projeto…. Você também pode abri-la a partir de Configurar página… em um documento, ou de Preferências do projeto… (Início ▾ no Início) do projeto aberto.
  2. Escolha Marcação própria.
  3. Em Marcação padrão, escolha uma entrada, preencha os campos dela (por exemplo Empresa) e clique em Adicionar à marcação.

    Você vê Cabeçalho, Rodapé e Aviso preenchidos. Adicione outra entrada para combiná-las: cabeçalhos e rodapés são unidos com " · ", e cada aviso vira um parágrafo próprio.

  4. Edite o texto, se necessário, e clique em Salvar.

    O aviso diz "Marcação do projeto salva." Somente os proprietários do projeto alteram a marcação do projeto; os outros membros a veem somente leitura.

Limpar esvazia os três campos. Sem marcação desativa a marcação no projeto, também quando a organização tem uma.

Definir a marcação da organização

  1. Abra o menu da conta e escolha Ajustes da organização, depois abra a organização.
  2. Em Marcação do documento, clique em Editar marcação….
  3. Defina a marcação como para um projeto e clique em Salvar.

    O aviso diz "Marcação da organização salva." Ela vale para todos os projetos da organização que não têm marcação própria. Somente os administradores da organização a alteram.

Dar a um documento sua própria marcação, uma capa e números de página

  1. Em um documento, abra Entregar ▾ e escolha Configurar página….
  2. Em Marcação, escolha uma opção:
    • Marcação do projeto ou da organização (o padrão): a linha abaixo nomeia a marcação que o documento usa.
    • Marcação própria: defina o cabeçalho, o rodapé e o aviso como para um projeto.
    • Sem marcação: o documento e as exportações dele não levam nenhuma.
  3. Preencha o resto:
    • Capa, com Versão e Preparado por. A capa também mostra o aviso.
    • Números de página ("Página X de Y") nas exportações Word.
  4. Clique em Aplicar.

    O aviso diz "Configuração de página salva." O cabeçalho e o rodapé aparecem no topo e na base do documento, e o aviso sob o título. ⌘Z / Ctrl+Z desfaz a alteração em uma única etapa.

Vale a marcação mais próxima: a do próprio documento, senão a do projeto, senão a da organização.

Onde as marcações são impressas

  • Visão de documento e Imprimir ou PDF…: o cabeçalho e o rodapé no topo e na base de cada página, o aviso sob o título.
  • A exportação Word (Entregar ▾ → {template} (Word), ou Documento (Word) em Todas as exportações…): o cabeçalho e o rodapé se repetem em todas as páginas, com números de página se escolhidos, e a capa substitui o título simples. Um bloco de matriz dinâmica no documento vira uma tabela do Word com o título acima, as mesmas larguras de coluna e os cabeçalhos I/A/R/T, e as lacunas sombreadas em vermelho.
  • Exportar matriz e Matriz de rastreabilidade (Word) ou (HTML).
  • Outros arquivos Word: as exportações do documento ICD, da apresentação, do diagrama e de Decomposição (Word) levam o cabeçalho e o rodapé em todas as páginas e o aviso sob o título.
  • Relatórios Excel: o cabeçalho e o rodapé vão para o cabeçalho e o rodapé de página de cada planilha, que o Excel mostra no modo de exibição Layout da Página e imprime.
  • CSV: somente quando você marca Marcação como primeira linha em Tabela (CSV). Fica desativado por padrão, para que o arquivo possa ser importado de novo como está.
  • Imagens de diagrama: as exportações PNG e SVG recebem uma faixa acima do diagrama com o cabeçalho e uma faixa abaixo com o rodapé e o aviso. As exportações Página web (HTML) os mostram no topo e na base da página. As miniaturas e as imagens de diagrama dentro de documentos ficam sem marcação.
  • Apresentações: os slides em PowerPoint, página web, PNG e SVG mostram o cabeçalho e o rodapé em todos os slides e o aviso no primeiro slide.
  • Uma compilação tem o seu próprio Configurar página, usado quando você exporta a compilação.

Checagens do modelo

As Checagens do modelo relatam um valor dinâmico ou uma tabela dinâmica que aponta para algo excluído (regra Global.7, "Valores dinâmicos que apontam para destinos ausentes"):

  • Um Valor dinâmico cuja entidade foi excluída mostra "{Entity: … Not found}".
  • Um bloco de matriz cujo documento de escopo foi excluído, um bloco Relatório de teste cuja suíte de testes ou ciclo de teste foi excluído, ou uma Matriz personalizada cujo relacionamento não existe mais.
  • Uma Contagem ou total ou uma Tabela dinâmica cuja consulta cita uma classe, um rótulo, um relacionamento ou um documento que não existe.
  • Uma Referência cruzada cujo item, figura ou tabela foi excluído.

Abra a descrição e edite ou remova o valor dinâmico, ou insira-o de novo para um destino que exista. Veja Checagens do modelo.

Dicas

  • Coloque a RVTM ou a VCRM no fim de uma especificação como sua seção de verificação; ela se mantém atualizada até a revisão.
  • Para um pacote de revisão, monte uma compilação e dê a ela uma capa e uma marcação no seu próprio Configurar página.
  • Exporte a VCRM para Excel para um comitê de revisão que faça anotações nela, e mantenha o bloco dinâmico no documento.
  • Para um plano de verificação organizado por nível de integração, use a VCRM por nível de verificação e defina antes o Nível de verificação de cada requisito.
  • Para um documento de controle de interfaces, insira uma Matriz de interfaces com escopo no Asset do sistema, para que os filhos dele e os Conduits deles apareçam na diagonal e nas células.