Holarch

Requisitos

Documentos

Escreva, estruture, numere, coloque em linha de base e publique especificações como vistas vivas do modelo, com modelos de documento, rich text, relatórios e saída em Word.

Como usá-lo →

Nesta página
  1. Visão geral
  2. Conceitos
    1. O que faz de algo um documento
    2. Tipos de documento
    3. Números
    4. Linhas de base
  3. Como usá-lo
    1. Quando e por quê
    2. Criar uma especificação de requisitos a partir de um modelo
    3. Escrever requisitos
    4. Adicionar muitos requisitos rapidamente
    5. Reestruturar
    6. Revisar, criar linha de base e publicar
    7. Exemplo prático: a demonstração CubeSat EO-1
    8. Dicas e boas práticas
    9. Erros comuns
    10. Como se conecta a outros recursos
  4. A lista de documentos
  5. A página do documento
    1. Cabeçalho da página
    2. Barra de ferramentas
    3. Painel da estrutura
    4. O corpo do documento
    5. Menu de clique com o botão direito
    6. Adição rápida
    7. Inspetor
  6. Adicionar itens
    1. Itens novos
    2. Outras classes
    3. Documentos estruturados com Headings
    4. Entidades existentes
  7. Reestruturar
    1. Recuar, recuar à esquerda e mover
    2. Arrastar e soltar
    3. Mover para baixo de
  8. Numeração
    1. Renumeração automática
    2. Regras do próximo número
    3. Renumerar
    4. Numeração do documento (metanúmeros)
  9. Modelos
    1. Modelos nativos
    2. Salvar um documento como modelo
    3. Gerenciar modelos
    4. Modelos salvos neste navegador
    5. Aplicar um modelo a um documento existente
  10. Editor de texto formatado
    1. Barra de ferramentas
    2. Tabelas
    3. Imagens e arquivos
    4. Texto alternativo
    5. Links e links incorporados
    6. Conteúdo dinâmico
    7. Ferramentas de texto com IA
    8. Colar
    9. Atalhos do texto formatado
  11. Localizar no documento
  12. Localizar e substituir
  13. Menu Escrever
    1. Definir atributo neste ramo
    2. Dividir em vários itens
  14. Menu Checar
    1. Status de rastreamento
    2. Encontrar acrônimos
  15. Menu Entregar
    1. Modelos do Word
    2. Arquivos Word da empresa
  16. Menu Exibir
  17. Linhas de base
    1. Criar uma linha de base
    2. Ver uma linha de base
    3. Comparar versões
  18. Relatórios
  19. Saída Word
    1. Legendas, listas e referências cruzadas
    2. Configuração do entregável
    3. Formato da página
    4. Conversão do texto formatado
    5. Redline
    6. Imprimir / PDF
  20. Comentários
  21. Compilações
    1. Seções geradas
    2. Compilação no Word
  22. Ferramentas de IA
  23. Atalhos de teclado
  24. Ajustes lembrados neste navegador
  25. Mensagens
  26. Limites
  27. Relacionado

Visão geral

Um documento é uma especificação, um plano ou um procedimento cujas seções e requisitos são entidades do modelo. Use a página do documento para escrevê-los e reestruturá-los, numerá-los, colocá-los em linha de base e publicá-los em Word, Excel, ReqIF, Markdown e outros formatos.

Cada item de um documento é uma entidade. Por isso o mesmo requisito também aparece no Banco de dados, nos diagramas, na Matriz de rastreabilidade e no verificador de qualidade. Uma edição em qualquer um desses lugares aparece no documento.

Conceitos

O que faz de algo um documento

  • Um documento é uma entidade Artifact que atende a uma de duas condições:
    • Ela leva um rótulo de tipo de documento: qualquer rótulo cujo nome termine em "Document".
    • Ela tem um relacionamento source of com pelo menos um Statement ou Heading.
  • Seus itens de nível superior são as entidades com as quais o documento tem source of. Os itens mais profundos ficam sob eles por relacionamentos decomposed by. A estrutura que você vê é essa árvore de decomposição.
  • Os itens costumam ser Statements (seções, títulos, notas, premissas) e Requirements (e suas subclasses). Adicione qualquer outra classe com Outra classe….
  • Os Headings (documentos estruturados do LML 2.0) são seções que contêm itens de qualquer classe. Uma subseção é um Heading sob um Heading (decomposed by). Qualquer outro item sob um Heading é o conteúdo da seção: o Heading o contains, ele mantém seu próprio número e é listado antes das subseções. Veja Documentos estruturados com Headings.
  • Remover um item de um documento não exclui a entidade. Excluí-lo do Banco de dados, sim.

Tipos de documento

O tipo é o rótulo de tipo de documento do documento. Ele decide quais modelos são oferecidos primeiro e se o documento abre no modo papel.

TipoModelos nativos
Requirements DocumentRequirements Specification; Stakeholder Requirements Specification (StRS); System Requirements Specification (SyRS); Software Requirements Specification (SRS); Interface Requirements Specification (IRS)
Interface Control DocumentInterface Control Document (ICD)
Concept of Operations DocumentConcept of Operations
Needs Analysis DocumentNeeds Analysis
Concept Exploration DocumentConcept Exploration; Trade Study Report
Concept Definition DocumentConcept Definition; Architecture Description
Systems Engineering Management Plan DocumentSystems Engineering Management Plan
Test Plan DocumentTest Plan; Verification and Validation Plan; Test Procedure; Test Report
Independent Verification & Validation Plan DocumentIV&V Plan
Project Management Plan DocumentProject Management Plan; Risk Management Plan; Configuration Management Plan
Integrated Logistics Support Plan DocumentIntegrated Logistics Support Plan
Standard Operating Procedure DocumentStandard Operating Procedure

Os modelos dos outros tipos são listados em Outros modelos, então qualquer modelo pode iniciar qualquer documento.

Para adicionar um tipo de documento, adicione à classe Artifact um rótulo cujo nome termine em "Document" (veja Extensões de esquema). Um documento com o rótulo Pacote de revisão reúne outros documentos; veja Compilações.

Números

Cada item tem um número, como 3.2, mostrado antes do nome. Os números são armazenados na entidade, então o mesmo requisito mostra o mesmo número em todos os lugares. A exceção é a numeração do documento, que mantém números separados por documento.

O Holarch mantém os números em ordem para você enquanto Renumerar automaticamente ao adicionar ou mover itens estiver ativado (o padrão; a caixa de seleção fica em Escrever ▾ → Renumerar…).

Linhas de base

Uma linha de base é um instantâneo somente leitura do documento. Ela contém:

  • Os itens do documento, seus atributos e seus relacionamentos, incluindo vínculos com entidades a um passo fora do documento.
  • Os ajustes do documento.
  • Registros de aprovação datados, que não podem ser editados depois.

As linhas de base alimentam os relatórios de mudanças e as tabelas de Histórico de revisões e de Aprovações da saída Word.

No serviço hospedado:

  • Cada registro de aprovação recebe a hora do servidor e a conta que o salvou, não o relógio do navegador. O registro mostra "(hora do servidor) · registrado por {name}", e o salvamento é gravado no log de auditoria.
  • Apenas os proprietários do projeto podem renomear ou excluir uma linha de base. Para os outros, Excluir e o campo de nome ficam esmaecidos com "Apenas um proprietário do projeto pode renomear ou excluir uma linha de base." Restaurar e reverter funcionam como antes.

No aplicativo desktop, os registros levam a data em que o seu computador os salvou.

Como usá-lo

Quando e por quê

Use um documento quando o entregável for uma especificação que alguém vai ler, revisar e assinar. Exemplos:

  • Uma especificação de requisitos de sistema para a SRR.
  • Um conceito de operações no início do desenvolvimento do conceito.
  • Um plano de teste antes do início da verificação.
  • Um procedimento para as operações.

Escreva os requisitos aqui e depois rastreie-os até funções, assets e testes em outras partes do modelo. O documento responde a "O que esta especificação diz, em que ordem, e o que mudou desde que foi aprovada?"

No fluxo da engenharia de sistemas, os documentos vêm primeiro: necessidades das partes interessadas e requisitos de sistema. Eles alimentam a análise funcional e a alocação. Nas revisões, eles voltam como saídas aprovadas e em linha de base, com relatórios de rastreabilidade.

Criar uma especificação de requisitos a partir de um modelo

  1. Na barra de navegação, abra Necessidades e requisitos → Documentos.
  2. Clique em + Novo documento no cabeçalho da página.

    Novo documento é aberto.

  3. Insira o Nome (obrigatório). Número e descrição podem ser adicionados depois no inspetor.
  4. Em Modelo, Modelos para mostra os modelos de um tipo de documento, por exemplo Requirements Document. Cada cartão mostra as primeiras seções como pré-visualização. Escolha uma destas opções:
    • Em branco: um documento vazio do tipo mostrado.
    • Uma entrada de Modelos da organização (servidores Holarch, hospedados ou auto-hospedados), publicada pelos administradores da sua organização. O padrão da organização para o tipo vem pré-selecionado.
    • Uma entrada de Modelos do projeto, salva neste projeto.
    • Uma entrada de Modelos integrados.
    • Um modelo de outro tipo de documento, em Outros modelos.

      O documento recebe o tipo do modelo escolhido.

  5. Selecione Incluir orientações de redação para adicionar um breve guia de redação a cada seção de um modelo integrado.
  6. Clique em Criar.

    O documento abre com as seções numeradas do modelo, por exemplo 1 Document Control, 1.1 Revision History, 1.2 Approvals, 2 Introduction … Se você incluiu orientações de redação, exclua-as à medida que escreve cada seção.

Escrever requisitos

  1. Clique na linha de uma seção para selecioná-la.
  2. Clique em + Filho, ou pressione ⌥⌘↵ / Ctrl+Alt↵.

    Aparece uma nova linha chamada "New Requirement" com seu número, e o nome dela fica pronto para digitação.

  3. Digite o nome e pressione Enter.
  4. Clique na descrição e escreva a declaração com "shall".
  5. Pressione ⌘↵ / Ctrl↵ ou clique em outro lugar para salvar a descrição.
  6. Para adicionar o próximo requisito no mesmo nível, pressione ⌘↵ / Ctrl↵ de novo.

+ Novo … (cabeçalho da página) adiciona o item no fim do documento; + Depois e + Filho o adicionam junto ao item selecionado (a dica de + Novo … informa isso). Os três adicionam a última classe que você escolheu nos menus ▾ deles (Requirement por padrão). Este navegador lembra a escolha.

Adicionar muitos requisitos rapidamente

Use a Adição rápida na parte inferior do documento para digitar requisitos um após o outro.

  1. Na barra Adição rápida, escolha a seção, por exemplo Sob 4 Command and Data Handling.
  2. Digite o texto do requisito.
  3. Pressione Enter.

    O Holarch adiciona o requisito e o nomeia a partir das palavras após "shall". O cursor fica no campo para o próximo.

Reestruturar

Altere a estrutura com teclas, arrastando ou pelo menu do botão direito. Com a renumeração automática ativada, os números se atualizam após cada movimento.

  • Com teclas: selecione uma linha e pressione:
    • ⌥⇧→ / Alt+Shift+→ para recuá-la sob o item acima.
    • ⌥⇧← / Alt+Shift+← para recuá-la à esquerda.
    • ⌥ / Alt+↑ ou ⌥ / Alt+↓ para movê-la entre seus irmãos.
    • Tab não é usado para recuar, então ele sempre passa para o próximo campo.
  • Arrastando: arraste linhas no painel Estrutura. Solte na borda superior ou inferior de uma linha para colocar o item antes ou depois dela. Solte no meio para torná-lo filho.
  • Pelo menu: clique com o botão direito na linha e escolha Mover para baixo de ▸, depois escolha o novo pai na lista (digite para filtrá-la). Os filhos vão junto.

Revisar, criar linha de base e publicar

  1. Escolha Checar ▾ → Checar qualidade e corrija os requisitos fracos (veja Requisitos).
  2. Escolha Checar ▾ → Status de rastreamento… e vincule os requisitos que ainda não estão alocados ou verificados.
  3. Resolva os itens em aberto em Checar ▾ → Registro de TBD/TBR.
  4. Revise Checar ▾ → Vínculos a revisar.
  5. No bloco de título, clique em Versão ▾ e escolha Salvar linha de base….
  6. Insira um nome, por exemplo "SRR Baseline".
  7. Adicione uma linha de aprovação por aprovador, com nome, função e declaração.
  8. Clique em Criar.

    A linha de base aparece em Versão ▾, e o botão a nomeia como a última linha de base.

  9. Clique em Entregar ▾ → Especificação (Word).

    O arquivo Word é baixado com as opções do modelo Specification, incluindo as tabelas de Histórico de revisões e de Aprovações preenchidas a partir das linhas de base.

  10. Abra o arquivo no Word e aceite o aviso para atualizar os campos.

    O sumário é preenchido.

Para que o documento seja revisado antes da linha de base, clique em Solicitar revisão ao lado do tipo de documento. Os revisores do projeto o encontram em Documentos a revisar em Meu trabalho e o aprovam ou rejeitam ali ou na faixa abaixo do título.

Depois de edições posteriores, veja o que mudou:

  1. Clique em Versão ▾ → Comparar versões….
  2. Escolha a linha de base em De e Versão atual em Para.

    O relatório lista cada adição, remoção e edição. Clique em Alterações (Excel) para baixá-lo, ou em Redline (Word) para um arquivo Word com alterações controladas.

Exemplo prático: a demonstração CubeSat EO-1

Crie a demonstração em Gerenciar projetos → Arquivos do projeto ▾ → Novo projeto de demonstração. Depois abra Necessidades e requisitos → Documentos → EO-1 System Requirements Specification (número SRS-001).

Leia a estrutura. Seis seções contêm os requisitos:

  • 1 Mission Imaging
  • 2 Attitude Determination and Control
  • 3 Electrical Power
  • 4 Command and Data Handling
  • 5 Communications
  • 6 Ground Segment and Operations

O requisito 1.6 Revisit Time tem dois filhos, 1.6.1 Ground Track Repeat e 1.6.2 Off-Nadir Imaging. A coluna Pontuação de qualidade mostra barras. 2.5 Safe Mode Recovery e 6.4 Operator Interface têm pontuação baixa.

Corrija a redação fraca:

  1. Pressione ⌘F / Ctrl+F e digite should.

    O contador mostra as correspondências.

  2. Pressione Enter até o 2.5 ficar marcado.

    O texto dele é "The spacecraft should recover from safe mode quickly and resume imaging as appropriate".

  3. Reescreva-o, por exemplo "The spacecraft shall resume imaging within 24 hours of a safe mode entry."

    A coluna de pontuação mostra uma etiqueta Desatualizado até você executar a checagem de novo.

Divida um requisito composto:

  1. Selecione 6.4 Operator Interface ("…shall be user friendly and/or easy to use.").
  2. Clique com o botão direito nele e escolha Dividir em vários itens….
  3. Clique em ✦ Propor uma divisão.

    Você recebe um requisito mensurável por linha.

  4. Desmarque as linhas que você não quer, ou clique em Unir para mesclar uma linha com a seguinte, e clique em Aplicar.

Adicione um requisito rapidamente:

  1. Em Adição rápida, escolha Sob 3 Electrical Power.
  2. Digite "The EPS shall provide a 5 V regulated bus within 3%." e pressione Enter.

    Ele é adicionado como 3.7, com o nome "Provide A 5 V Regulated".

Veja o que mudou desde a SRR:

  1. Clique em Versão ▾ no bloco de título e escolha SRR Baseline.

    O banner diz "Linha de base “SRR Baseline”, somente leitura, salva em {date}". Os aprovadores são J. Rivera, Systems Lead; R. Okafor, Mission Principal Investigator; e L. Brandt, Program Manager.

  2. Clique em Comparar com a versão atual.

O relatório lista:

  • 3.1 Orbit Average Power: descrição alterada de 28 W para 30 W, e uma nova justificativa.
  • 2.4 Target Slew: Status Rascunho → Em revisão.
  • O 4.4 Downlink Encryption adicionado, com seus dois novos vínculos satisfies.
  • Suas próprias edições desta sessão.

Publique:

  1. Clique em Voltar à versão atual.
  2. Clique em Entregar ▾ → Especificação (Word).

    O arquivo Word começa com o título e "Requirements Document · No. SRS-001". Seguem uma linha do Histórico de revisões para SRR Baseline ("Initial baseline") e as três aprovações, e depois os requisitos numerados.

Dicas e boas práticas

  • Escreva um requisito por linha, com um único "shall". Dividir em vários itens… e a checagem de qualidade ajudam a manter os requisitos singulares.
  • Mantenha as seções como Statements e os requisitos como Requirements. A checagem de qualidade só pontua Requirements. Os relatórios só de requisitos (RVTM, VCRM, RTM) ignoram os Statements.
  • Crie uma linha de base antes de cada revisão e antes de grandes reescritas. A reversão e os relatórios de mudanças dependem dela.
  • Um clique em uma linha a seleciona. Para editar, clique no próprio campo, ou pressione Enter ou F2 na linha selecionada.
  • Use Exibir ▾ → Papel para ler o documento como uma página, sem colunas de atributos. Desative-o para editar atributos em colunas.
  • Fique de olho nos pontos de status de rastreamento: um requisito está pronto para revisão quando o ponto dele está verde.

Erros comuns

  • Adicionar está esmaecido. Há um filtro ou uma ordenação ativa (Visão filtrada: edição desativada. Limpar filtro na barra de ferramentas), ou você está vendo uma linha de base. Clique no aviso, ou em Voltar à versão atual.
  • Os números saltaram após um movimento. A renumeração automática reescreve os números do grupo de irmãos. Para manter números definidos manualmente, desmarque Renumerar automaticamente ao adicionar ou mover itens em Escrever ▾ → Renumerar…, ou bloqueie os itens cujos números não podem mudar.
  • Removi um item e ele continua no Banco de dados. Remover apenas o tira do documento. Para excluí-lo, escolha Excluir item… na mensagem que aparece em seguida, faça ⇧ / Shift-clique em Remover, ou pressione ⇧Delete / Shift+Delete.
  • A numeração com letras ou algarismos romanos virou decimal. A renumeração automática e Renumerar… produzem números decimais (1, 1.1, 1.1.1). Para manter apêndices com letras, desative a renumeração automática e numere-os manualmente.

Como se conecta a outros recursos

  • Recebe de:
    • Importar cria documentos a partir de Word, Excel, CSV, ReqIF, XMI e texto.
    • Os modelos criam o esqueleto.
    • Os geradores de IA adicionam requisitos.
  • Alimenta:
  • Em todos os outros lugares: cada item é uma entidade. Ele aparece no Banco de dados, na Visão do item e em diagramas como Spider e de árvore.

A lista de documentos

A lista de documentos mostra cada documento do projeto como um cartão, na mesma galeria da página Diagramas. Abra-a com Necessidades e requisitos → Documentos.

Cada cartão mostra:

  • Uma miniatura da estrutura do documento.
  • O nome, o tipo e quando foi editado pela última vez (a mudança mais recente no documento ou em qualquer item).
  • "N itens · N requisitos".
  • Qualidade média N%, quando os requisitos têm pontuação.
  • N TBD/TBR: os itens em aberto.
ControleO que ele faz
Pesquisar documentos…Mostra os cartões cujo nome, número ou descrição contém o texto.
OrdenaçãoEditados recentemente (padrão), Número (ordem da estrutura), Nome, Classe.
Pílulas de tipoTodos e uma pílula por tipo de documento, com sua contagem.
Mostrar mais (N)Mostra mais cartões.
Importar (cabeçalho da página)Abre a página Importar (Importação e exportação).
+ Novo documento (cabeçalho da página)Abre Novo documento.
⋯ em um cartãoAbrir, Abrir em ▸ Visão do item, Duplicar… e Excluir….

Excluir… abre Excluir documento: "Exclui "…". Suas N seções permanecem no projeto como itens." Quando algumas seções não estão em nenhum outro documento, Excluir também as N seções que nenhum outro documento usa as exclui também. Desfazer restaura tudo.

Clique em um cartão para abrir o documento.

O endereço documents/<id> abre um documento diretamente. Acrescente ?baseline=<id> ou ?baseline=latest para abrir uma linha de base, ?find=<text> para iniciar uma pesquisa, ou ?comments=1 para mostrar os comentários do documento no inspetor.

A página do documento

A página do documento mostra um documento como uma estrutura e uma tabela, com o item selecionado no inspetor.

  • + Novo {Class} adiciona um item da classe atual no fim do documento. Seu ▾ abre o menu de classes:
    • Adicionar item existente….
    • Inserir documento… e Inserir seção gerada… (apenas compilações).
    • No cabeçalho Adicionar no fim: todas as classes Statement e Título (a atual tem um ✔), e Outra classe….
  • ✦ IA ▾ (na barra superior) contém as ferramentas de IA do documento (veja Ferramentas de IA).

Barra de ferramentas

ControleO que ele faz
+ DepoisAdiciona um item depois do selecionado, no mesmo nível (⌘↵ / Ctrl↵). Seu ▾ acrescenta Adicionar item existente…, Adicionar filho (⌥⌘ / Ctrl+Alt↵) e a lista de classes em Adicionar depois do item selecionado.
+ FilhoAdiciona um filho do item selecionado (⌥⌘↵ / Ctrl+Alt↵). Seu ▾ oferece Adicionar item existente… e a lista de classes em Adicionar um filho.
⇤ / ⇥Recuar à esquerda (⌥⇧← / Alt+Shift+←) / recuar (⌥⇧→ / Alt+Shift+→) o item selecionado.
↑ / ↓Mover o item selecionado para cima ou para baixo entre seus irmãos (⌥ / Alt+↑ / ⌥ / Alt+↓).
RemoverTira os itens selecionados e suas subárvores do documento na hora (Delete faz o mesmo). Removido do documento. oferece Desfazer e Excluir item…. ⇧ / Shift-clique ou ⇧Delete / Shift+Delete exclui os itens e seus filhos após uma confirmação que nomeia o que é excluído. Esc ou o × do inspetor limpa a seleção.
Escrever ▾Adicionar, inserir, gerar e editar conteúdo (veja Menu Escrever).
Checar ▾Qualidade, checagens do modelo, status de rastreamento, vínculos a revisar, TBD/TBR e comentários deste documento, com contagens (veja Menu Checar).
Entregar ▾Configuração do entregável e da página, o modelo do Word, as versões e as exportações agrupadas por saída (veja Menu Entregar).
Exibir ▾Alternâncias diretas para este documento: Papel, Painel da estrutura, Status de rastreamento e Colunas (veja Menu Exibir).
Visão filtrada: edição desativada. Limpar filtroAparece enquanto um filtro de classe ou de rótulo ou uma ordenação de coluna está ativo. Clique para limpá-los.
LocalizarAbre a caixa de pesquisa (⌘F / Ctrl+F).

Os botões de estrutura ficam desativados quando:

  • Nada está selecionado.
  • O item selecionado está bloqueado.
  • Um filtro ou uma ordenação está ativo.
  • Você está vendo uma linha de base.

Painel da estrutura

O painel da estrutura, à esquerda, mostra a hierarquia do documento, com um filtro no topo. Não há abas: as linhas de base ficam em Versão ▾ do bloco de título, e os comentários abrem no inspetor.

  • ‹ oculta o painel, e › na borda esquerda o mostra de novo (também Exibir ▾ → Painel da estrutura).
  • Arraste a borda direita dele para redimensioná-lo (de 180 a 500 px).
  • Selecionar um item abre o inspetor ao lado do painel; o painel continua aberto.
  • Quando o painel e o documento juntos têm menos de 900 px (contando o inspetor como aberto, para que selecionar um item não mude isso), o painel se recolhe. Ele então abre como sobreposição a partir de ›. Clique fora para fechá-lo.

Filtrar no topo do painel:

  • Filtrar a estrutura restringe a estrutura aos itens cujo número ou nome contém o texto, incluindo os recolhidos. Os pais deles continuam na estrutura, esmaecidos, como contexto. Isso não filtra o documento.
  • Chips de classe, um por classe do documento, com sua contagem (mostrados quando o documento tem mais de uma classe). Clique em um chip para mostrar no documento apenas essa classe e suas subclasses; clique de novo para mostrar todas as classes. Clique com o botão direito em um chip para {Class} e subclasses, Somente {Class} e Limpar filtro de classe.
  • Chips de rótulo, um por rótulo usado no documento, com contagens. Clique nos chips para mostrar apenas os itens com todos os rótulos escolhidos. Para itens com qualquer um de vários rótulos, use uma consulta no Banco de dados.
  • Com mais de seis chips, eles se recolhem atrás de Filtrar por classe ou rótulo (n); recolhidos, só os chips em vigor continuam visíveis. Menos filtros os recolhe de novo. Este navegador lembra a escolha.
  • Limpar filtro aparece enquanto um filtro ou uma ordenação está ativo. As linhas filtradas mantêm seu recuo. A edição fica desativada enquanto um filtro ou uma ordenação está ativo.

A estrutura:

  • Cada item tem sua amostra de cor, número e nome, 🔒 quando bloqueado, e botões ▾/▸.
  • Clique em uma entrada para selecionar o item e rolar até ele.
  • Arraste para reordenar (veja Arrastar e soltar). Os destinos inválidos são marcados e recusados: um item não pode ir para baixo de seu próprio filho, de um item bloqueado, ou de uma classe que não pode ser decomposed by ele.
  • As linhas da parte do documento que está à vista ficam destacadas, e a estrutura rola junto com o documento. Ela fica parada enquanto você aponta para ela, trabalha nela ou se você a rolou nos últimos dois segundos.
  • Os níveis profundos que não cabem mostram uma etiqueta de nível L{n} em vez de mais recuo.

O corpo do documento

O corpo começa com o bloco de título: o tipo e os rótulos do documento, a contagem de itens, "numerado por documento" quando os números do documento estão ativados, 💬 n comentários em aberto (quando há algum; veja Comentários) e Versão ▾ (veja Linhas de base). Versão ▾ diz Versão atual, Atual · última linha de base {name} ou Linha de base: {name}. Abaixo deles:

  • Nº e o título: clique para editar o número e o nome do documento, ou chegue a eles com Tab e pressione Enter ou F2.
  • A descrição do documento: clique para editá-la no editor de texto formatado, ou chegue a ela com Tab e pressione Enter ou F2.
  • A tabela. A coluna Entidade contém cada item: botão de expandir, número, nome, selos e descrição. As outras colunas são as colunas de atributo escolhidas em Exibir ▾ → Colunas ▸: Status, Método de verificação e Pontuação de qualidade até você mudá-las. A visão Papel não tem nenhuma.

Cada linha mostra:

  • ▾/▸ para recolher ou expandir seus filhos.
  • O número e o nome. Clique para editar, ou chegue a um deles com Tab e pressione Enter ou F2. Enter salva e Esc cancela; o foco fica no campo. As quebras de linha coladas viram espaços.
  • Selos:
    • 🔒: o item está bloqueado.
    • ⚡: o item tem orientações. Aponte para ele para lê-las.
    • 💬 n: comentários não resolvidos. Clique para abri-los no inspetor.
    • ⚠ Revisar: um requisito a montante mudou.
    • O selo da classe.
    • O ponto de status de rastreamento (apenas requisitos; veja Status de rastreamento).
  • A descrição, editada no editor de texto formatado.
  • Uma barra colorida na borda esquerda: azul quando o item não mudou desde a linha de base mais recente, âmbar quando é novo ou foi alterado.
  • Células de atributo:
    • Rótulos mostra chips com × para remover e + para adicionar. O menu lista os rótulos que a classe permite, ou "Não há mais rótulos".
    • Os atributos de texto são editados no lugar. Os outros atributos usam o editor do seu tipo.
    • Pontuação de qualidade mostra uma barra colorida: verde a partir de 67%, âmbar de 34% a 66%, vermelha abaixo disso. Ela mostra uma etiqueta Desatualizado com um ícone de relógio quando o texto mudou depois da última checagem; aponte para ela para ver o motivo.
    • "—" significa que a classe não tem esse atributo.

Ordenação e largura das colunas:

  • Clique no cabeçalho de uma coluna para ordenar em ordem crescente, de novo para decrescente, e uma terceira vez para desativar a ordenação.
  • A ordenação lista os itens sem hierarquia e pausa a redação.
  • Arraste a borda direita de um cabeçalho para redimensionar a coluna. A coluna Entidade tem pelo menos 300 px de largura, as outras pelo menos 80 px. As larguras são mantidas por documento neste navegador.
  • Uma linha em branco separa as seções de nível superior.

Selecionar linhas:

  • Clique em uma linha para selecioná-la. Um clique só seleciona; para editar, clique no campo, ou pressione Enter ou F2 na linha.
  • Para desfazer a seleção, clique no espaço vazio abaixo da tabela, pressione Esc ou clique em ✕.
  • ↑ e ↓ movem a seleção entre as linhas.
  • ⌘ / Ctrl-clique (Ctrl-clique no Windows e no Linux) adiciona um item à seleção ou o retira dela.
  • ⇧ / Shift-clique seleciona o intervalo do último item clicado até este, na ordem mostrada (com qualquer ordenação ou filtro). ⌘ / Ctrl+⇧ / Shift-clique adiciona esse intervalo à seleção.
  • ⌘A / Ctrl+A em um item com foco (fora da edição) seleciona todos os itens mostrados. ⇧ / Shift+↑ e ⇧ / Shift+↓ estendem a seleção a partir do item com foco.
  • Os mesmos gestos funcionam na Estrutura. A barra de ferramentas mostra a contagem ("21 selecionados"). Um clique simples, ou Esc, volta a um único item.
  • Os cliques em um campo que você está editando mantêm o comportamento de texto: ⇧ / Shift-clique ali estende a seleção de texto.

Menu de clique com o botão direito

Clique com o botão direito em um item do documento (seu número, nome, selos ou o espaço ao redor deles) ou em uma entrada da Estrutura para abrir o menu dele no ponteiro. Pelo teclado, coloque o foco na linha ou na entrada da Estrutura e pressione Shift+F10 ou a tecla Menu; o menu abre no item e Esc devolve o foco a ele. Em uma tela sensível ao toque, toque e mantenha pressionado o item. O item vira a seleção.

O menu começa com até três ações sugeridas escolhidas a partir do estado do item, cada uma com seu motivo à direita: por exemplo ✦ Adicionar critérios mensuráveis… (falha: Inequívoco), ✦ Gerar caso de teste… (não verificado), Revisar vínculo… (a montante mudou) ou Resolver TBD… (TBD em aberto). Sem nada a corrigir, ele sugere ✦ Checar com IA… e ✦ Perguntar à IA sobre isto…. ✦ Mais IA ▸ lista todas as ações de IA do item. As regras e a lista completa estão em Modelo e banco de dados. Cada ação de IA mostra seu resultado para revisão antes que algo mude. Quando a IA está desativada, a parte de IA é uma linha esmaecida que dá o motivo.

Os comandos depois do divisor. Uma tecla mostrada à direita de um comando faz o mesmo pelo teclado (veja Atalhos de teclado):

ComandoO que ele faz
Ir paraApenas na Estrutura. Rola o documento até o item e move o foco para ele (Enter na entrada da Estrutura).
AberturaAbre a Visão do item.
Renomear…Altera o nome. F2 em um item com foco no documento edita o nome no lugar.
Adicionar {class} depoisAdiciona um item da classe atual depois deste, como faz + Depois (⌘↵ / Ctrl↵).
Adicionar {class} filhoAdiciona um item da classe atual sob este, como faz + Filho (⌥⌘↵ / Ctrl+Alt↵).
Recuar, Recuar à esquerdaComo ⇥ e ⇤ na barra de ferramentas (⌥⇧→ / Alt+Shift+→ e ⌥⇧← / Alt+Shift+←).
Mover para cima, Mover para baixoComo ↑ e ↓ na barra de ferramentas (⌥ / Alt+↑ e ⌥ / Alt+↓).
Status ▸, Prioridade ▸Define o atributo; o valor atual fica marcado.
Relacionar com ▸Lista primeiro os relacionamentos mais usados para a classe, depois Todos os relacionamentos ▸ com todos os relacionamentos que a classe permite. Escolher um abre um seletor para as entidades de destino.
Mostrar no diagrama ▸Lista os tipos de diagrama que podem mostrar o item; escolher um o abre.
Copiar linkCopia um link para a Visão do item.
Copiar númeroCopia o número do item.
Abrir em ▸Visão do item, Histórico…, os diagramas que podem mostrar o item (de hierarquia, de árvore, Spider, de Action, de Asset, de Risk, de linha do tempo), Matriz de rastreabilidade, Qualidade dos requisitos e Análise funcional.
Mover para baixo de ▸Uma lista com filtro por digitação dos itens que podem conter este, recuados na ordem do documento, e Nível superior do documento quando ele tem um pai. Os filhos vão junto.
Dividir em vários itens…Veja Dividir em vários itens.
Alterar classe…Abre Mudar classe (o mesmo diálogo do Banco de dados; veja Modelo e banco de dados).
Renumerar a partir daqui…Abre Renumerar para este item, seus irmãos posteriores e os filhos deles.
Definir atributo neste ramo…Veja Definir atributo neste ramo.
Bloquear / DesbloquearBloqueia o item contra edições, ou o desbloqueia.
Remover deste documentoTira o item e seus filhos do documento (Delete). As entidades permanecem no projeto; a mensagem oferece Desfazer e Excluir item….
Excluir item…Exclui o item e seus filhos após confirmação (⇧Delete / Shift+Delete).

Cada comando pode ser revertido com um único Desfazer. Os comandos que não podem se aplicar ficam esmaecidos, e sua dica dá o motivo:

  • Em uma linha de base, ou com acesso somente de visualização, só Ir para, Abrir, Mostrar no diagrama ▸, Copiar link e Copiar número funcionam. Em uma linha de base, as sugestões e as ações ✦ de IA também ficam esmaecidas.
  • Em um item bloqueado, Renomear…, Status ▸, Prioridade ▸, Relacionar com ▸, os movimentos e Excluir item… ficam esmaecidos.
  • Enquanto um filtro ou uma ordenação está ativo, adicionar e mover ficam esmaecidos ("Limpe o filtro ou a ordenação primeiro").
  • Os comandos que levariam o item além do início ou do fim de seu nível ficam esmaecidos (por exemplo Mover para cima no primeiro item).

Vários itens selecionados. Um clique com o botão direito em um item da seleção age sobre todos os itens selecionados. O menu mostra N selecionados e oferece as ações ✦ em lote (✦ Checar com IA (n requisitos)…, ✦ Reescrever (n) ▸, ✦ Gerar casos de teste (n)…, ✦ Perguntar à IA sobre estes (n)…, ✦ Sugerir rastreamentos (n)…; veja IA em vários itens selecionados), Definir status ▸, Definir prioridade ▸, Adicionar ao documento ▸, Remover n deste documento e Excluir n itens… (após confirmação; os filhos dos itens selecionados vão junto). Os comandos para um único item (Ir para, Abrir, Renomear…, adicionar, recuar e mover) continuam listados, mas esmaecidos, com o motivo "Age sobre uma única entidade". Cada comando é uma etapa de desfazer. Um clique com o botão direito em um item fora da seleção o torna o único item selecionado.

A descrição e qualquer campo que você está editando mantêm o menu do próprio navegador, para que você possa copiar, colar e checar a ortografia ali. ⌥ / Alt-clique com o botão direito mostra o menu do navegador em qualquer lugar.

Adição rápida

Adição rápida permite digitar requisitos em sequência sem usar a barra de ferramentas. A barra abaixo do documento contém Adição rápida, a lista de seções, o campo de texto e Adicionar. A lista de seções oferece Fim do documento e Sob {number name} para cada seção de nível superior.

Digite um requisito e pressione Enter ou clique em Adicionar. O novo item recebe:

  • A classe atual.
  • O texto como descrição.
  • Um nome formado pelas primeiras palavras após "shall", "must", "will" ou "should": até cinco palavras, com iniciais maiúsculas.

O campo aceita até 2.000 caracteres. Enquanto um filtro ou uma ordenação está ativo, o campo diz "Limpe o filtro ou a ordenação para adicionar entidades".

Inspetor

O item selecionado abre no inspetor à direita, com o painel completo da entidade (veja Modelo e banco de dados).

  • Em um documento, os relacionamentos decomposed by e decomposes ficam somente leitura ali, porque a estrutura os controla.
  • O × do cabeçalho (Esc) limpa a seleção. Exibir ▾ → Recolher filhos recolhe as seções sob o item selecionado.
  • Os itens bloqueados abrem somente leitura.

Adicionar itens

Itens novos

  • + Novo {Class} adiciona no fim.
  • + Depois adiciona depois do item selecionado.
  • + Filho adiciona o último filho do item selecionado, e o pai se expande.
  • Sem seleção, + Depois e + Filho adicionam no fim.

Um novo item recebe o nome "New {Class}". Ele fica selecionado, e seu nome se abre para edição.

Outras classes

Outra classe… abre Adicionar item ao documento com Classe (qualquer classe) e Nome. Use-o para itens que não são Statement, como a descrição de um Asset ou um Test Case em um plano de teste.

Documentos estruturados com Headings

Um Título (Heading) é uma seção de um documento (a abordagem de artefatos estruturados do LML 2.0). Use Headings quando uma seção mistura classes, por exemplo requisitos, ações e riscos, ou quando o mesmo requisito aparece em vários documentos.

  1. Escolha Título em um menu de classes (+ Novo ▾, + Depois ▾ ou + Filho ▾). No nível superior, o documento tem um source of com o Heading; sob outro Heading, ele é uma subseção numerada.
  2. Selecione o Heading e use + Filho ▾ para adicionar seu conteúdo: um item novo de qualquer classe, ou Adicionar item existente…. O Heading contains o item.
  3. O conteúdo mantém seu próprio número: adicionar, mover e Renumerar… numeram os Headings e deixam os números do conteúdo como estão, de modo que um requisito como RQ.CLN.1 aparece igual em todos os documentos. O conteúdo da seção é listado antes das subseções.

Mover conteúdo para outro Heading (arrastar, Mover para baixo de ▸) move seu vínculo contains. As Checagens do modelo contam um requisito contido em um Heading como colocado em um documento.

Para registrar de onde veio um requisito, vincule-o ao Artifact de origem com originated by (inspetor → Relacionamentos; o Artifact o lista em originates). Um projeto criado antes dos Headings mantém seu esquema; Esquema → Adicionar novos itens nativos… adiciona Heading, contains e originates.

Exemplo na demonstração CubeSat EO-1: a seção 7 Applicable Documents de EO-1 System Requirements Specification é um Heading. Seu conteúdo são as duas normas do projeto, que mantêm seus números STD-1 e STD-2. STD-1 origina o requisito 3.4 Bus Regulation e STD-2 origina 5.2 UHF Command Uplink.

Entidades existentes

Adicionar item existente… abre um seletor de entidades. O seletor deixa de fora o documento e seus itens atuais. A entidade é adicionada com toda a sua decomposição. Quando ela traz filhos, a notificação diz "{entity} adicionado com N entidades filhas".

Reestruturar

Recuar, recuar à esquerda e mover

  • Recuar torna o item o último filho do irmão acima dele. O primeiro item de um grupo não pode ser recuado.
  • Recuar à esquerda torna o item o próximo irmão de seu pai.
  • Mover para cima/baixo troca o item com seu vizinho. Itens bloqueados e vizinhos bloqueados não se movem.
  • Quando um movimento não é possível, a notificação diz "A entidade selecionada não pode ir mais longe nessa direção."

Arrastar e soltar

Arraste no painel Estrutura. A lista rola quando você arrasta perto da borda superior ou inferior. O lugar onde você solta decide o resultado:

  • 28% superiores de uma linha: o item vai antes dela.
  • 28% inferiores de uma linha: o item vai depois dela.
  • Meio de uma linha: o item vira filho dela.
  • O nome do documento no topo: o item vira um item de nível superior no fim.

Mover para baixo de

Clique com o botão direito em um item e escolha Mover para baixo de ▸. A lista contém os itens que podem recebê-lo como filho, recuados na ordem do documento, e Nível superior do documento quando o item tem um pai. Digite para filtrar a lista e escolha o novo pai. Os filhos vão junto; a notificação diz "{item} movido".

A lista deixa de fora a própria subárvore do item, seu pai atual, os itens bloqueados e os pais que o esquema não permite. Quando o movimento falha, a mensagem diz "O item não pode ir para lá: o novo pai está dentro dele, ou o item está bloqueado. Escolha outro pai ou desbloqueie-o."

Numeração

Renumeração automática

Renumerar automaticamente ao adicionar ou mover itens vem ativado por padrão; altere-o em Escrever ▾ → Renumerar…. Enquanto ativado, estas ações renumeram o grupo de irmãos afetado e todos os descendentes: adicionar, mover, recuar, recuar à esquerda, remover e dividir.

  • Os itens de nível superior recebem o padrão de número do documento com um número sequencial. Ele começa no primeiro número do documento: 1, a menos que alterado em Renumerar….
  • Os filhos recebem o número do pai, um ponto e um número sequencial (3, 3.1, 3.1.1).
  • Os itens bloqueados e as entradas do glossário (itens com o rótulo Acronym, cujo número é o termo) mantêm seus números, mas ainda ocupam uma posição.

Com ele desativado:

  • Um novo item recebe o número seguinte ao do item anterior. Um primeiro filho recebe o número do pai mais .1.
  • Os números existentes não mudam.
  • Mover um item renumera apenas a subárvore movida.
  • Mover para cima/baixo troca os dois números.

Regras do próximo número

Para continuar uma sequência, o Holarch incrementa a última parte do número anterior. Ele mantém os separadores e um ponto, dois-pontos ou parêntese no fim.

  • Dígitos: 1.9 → 1.10, 2. → 3.
  • Letras: a → b, z → aa, Z → AA, Appendix A → Appendix B
  • Algarismos romanos de duas ou mais letras: IV → V, IX → X. Uma única letra conta como letra (I → J).
  • Qualquer outra coisa recebe .1 no fim.

Renumerar

Escrever ▾ → Renumerar… renumera o documento inteiro em uma etapa. Renumerar a partir daqui…, no menu do botão direito de um item, renumera esse item, seus irmãos posteriores e todos os filhos deles.

O diálogo tem:

  • Padrão: {n} é a posição e {n:3} a completa com zeros até três dígitos. SYS-{n:3} gera SYS-001, SYS-002; os filhos deles são numerados abaixo, SYS-001.1, SYS-001.2. Um padrão sem {n} recebe o número no fim. A partir de um item, o padrão e o primeiro número vêm preenchidos com base no número dele.
  • Primeiro número (apenas dígitos). Outra entrada mostra "Insira o primeiro número em dígitos, por exemplo 1."
  • Uma tabela de pré-visualização com Item, Atual e Novo (os números alterados ficam destacados; até 400 linhas), e uma contagem como "12 de 40 números mudam."
  • Renumerar automaticamente ao adicionar ou mover itens (apenas documento inteiro).
  • A nota "Itens bloqueados mantêm os números. Um único Desfazer reverte toda a renumeração." As entradas do glossário também mantêm os seus.
  • Renumerar. A notificação diz "Números do documento atualizados".

Uma execução no documento inteiro salva o padrão e o primeiro número com o documento. A renumeração automática posterior os usa.

Numeração do documento (metanúmeros)

A numeração do documento mantém números separados por documento. Use-a quando o mesmo requisito aparece em dois documentos com números diferentes.

Ative-a com Entregar ▾ → Configuração do entregável… → Numeração → Números do documento (mantidos apenas neste documento). Números do modelo (os números próprios dos itens) a desativa.

  • Quando você a ativa, o número atual de cada item é copiado para o documento.
  • A partir daí, as edições de número mudam apenas este documento.
  • O bloco de título mostra "· numerado por documento" enquanto ela está ativada.
  • As exportações e os relatórios usam os números do documento.

Modelos

Os modelos vêm de quatro lugares. Novo documento e Usar modelo os listam nesta ordem, primeiro os modelos deste tipo de documento:

GrupoOnde fica guardadoQuem pode adicioná-lo ou alterá-lo
Modelos da organização: {name}Nos servidores Holarch (hospedados ou auto-hospedados), para a organizaçãoAdministradores da organização
Modelos do projetoNo arquivo do projeto; todos os membros do projeto os veemProprietários do projeto (no aplicativo desktop: qualquer pessoa que abra o projeto)
Modelos nativosNo HolarchNinguém
Salvos neste navegadorApenas neste navegador (modelos salvos antes da versão 1.8.0)Importe-os para um projeto

Modelos nativos

Cada modelo integrado tem seções numeradas com tabelas iniciais (por exemplo as tabelas de Histórico de revisões e de Aprovações). Com Incluir orientações de redação, cada seção também começa com um breve guia de redação.

Novo documento mostra a contagem de seções de cada modelo, por exemplo "39 seções" para a Requirements Specification.

Os modelos seguem a prática comum de engenharia de sistemas para cada tipo de documento: especificações de requisitos das partes interessadas, de sistema, de software e de interface, um documento de controle de interfaces, uma descrição de arquitetura, planos de verificação e validação, de teste e de riscos, procedimentos e relatórios de teste, estudos de trade-off e gerenciamento de configuração.

Muitas seções contêm blocos dinâmicos que se atualizam a partir do modelo sempre que o documento é mostrado ou exportado:

BlocoEm
VCRM, VCRM por nível, RVTM e RTM dos próprios requisitos do documentoEspecificações de requisitos (seções Verification e Traceability)
VCRM e RVTM do projeto inteiroTest Plan, Verification and Validation Plan, Test Procedure, Test Report
Matriz de interfaces e a lista de condutosInterface Control Document, Architecture Description
Matriz de alocação (funções para componentes)Concept Definition, Architecture Description
Statements com o rótulo AcronymToda seção Acronyms
Artifacts com o rótulo ReferenceToda seção References
Riscos; Artifacts de Trade StudyRisk Management Plan; Trade Study Report

Uma matriz que abrange "este documento" aponta para o novo documento. Para o Test Report, adicione os resultados de um ciclo de teste com Inserir ▸ Matriz… ▸ Relatório de teste e escolha a suíte de teste e o ciclo.

Salvar um documento como modelo

Salve a estrutura de um documento como modelo para iniciar novos documentos a partir dela.

  1. Escolha Escrever ▾ → Modelos ▸ Salvar como modelo….

    Salvar {Type} como modelo é aberto.

  2. Insira o Nome do modelo.
  3. Em Salvar em, escolha:
    • Este projeto: todos os membros do projeto podem usá-lo. Apenas os proprietários do projeto veem esta opção.
    • Organização: {name} (servidores Holarch, administradores da organização): todos os membros da organização podem usá-lo. Marque Torná-lo o padrão da organização para {Type} para pré-selecioná-lo em Novo documento.
  4. Marque Incluir arquivos e imagens se o modelo deve mantê-los.
  5. Clique em Salvar.

Um modelo guarda a classe, o nome, o número, a descrição, o nível, os rótulos e os valores simples de atributo de cada item. Os resultados de qualidade ficam de fora. Uma matriz que abrange o documento salvo abrange o novo documento quando o modelo é aplicado.

Se você não puder salvar nenhum dos dois tipos, o diálogo informa isso: peça a um proprietário do projeto ou a um administrador da organização.

Gerenciar modelos

Escrever ▾ → Modelos ▸ Gerenciar modelos… lista os modelos do projeto. Os proprietários podem Renomear e Remover modelos; Desfazer restaura um modelo removido. Os documentos criados a partir de um modelo não mudam.

Os administradores da organização gerenciam os modelos da organização em Ajustes da organização → Modelos de documento: abra a organização e use Modelos de documento para renomear um modelo, ativar ou desativar Padrão (um padrão por tipo de documento) ou removê-lo.

Modelos salvos neste navegador

Antes da versão 1.8.0, os modelos personalizados eram salvos no navegador. Na primeira vez que um proprietário do projeto abre a lista de modelos, o Holarch oferece copiá-los para o projeto: Importar para o projeto ou Agora não. Até lá, eles continuam listados em Salvos neste navegador. Gerenciar modelos… tem Importar para o projeto e Remover do navegador para eles.

Aplicar um modelo a um documento existente

Escrever ▾ → Modelos ▸ Aplicar modelo… abre Usar modelo com Tipo de documento, Modelo, Salvar este documento como modelo… e Gerenciar modelos….

Aplicar adiciona as seções do modelo, com seus números e aninhamento, no fim do documento. A notificação diz "N seções adicionadas." Desfazer as remove.

Editor de texto formatado

O editor de texto formatado edita descrições com formatação, tabelas, imagens e conteúdo dinâmico. Clique em uma descrição (ou na descrição do documento) para editá-la. Pelo teclado, chegue à descrição com Tab e pressione Enter ou F2; os leitores de tela a anunciam como um campo de texto com o nome do item ("Descrição de 1.2 Power Budget").

O editor abre no lugar com uma barra de ferramentas, um contador de palavras e caracteres ("palavras: N · caracteres: N") e a dica "⌘↩ / Ctrl+Enter salvar · Esc cancelar · Tab sair".

  • Para salvar, pressione ⌘↵ / Ctrl↵, clique em ✓, clique fora do editor, ou pressione Tab para sair dele.
  • Para cancelar, pressione Esc. O foco volta à descrição.
  • Cada salvamento pode ser revertido com um único Desfazer.
  • Tab nunca recua, então não pode prender você no editor. Recue listas com ⌘ / Ctrl+] / ⌘ / Ctrl+[ ou ⇤ / ⇥.

Barra de ferramentas

BotãoO que ele faz
+Menu Inserir: ✦ Escrever com IA…, Imagem…, Texto alternativo… (quando o texto tem imagens), Tabela…, Bloco de código, Linha, Link…, Link para documento…, Arquivo…, Diagrama…, Valor dinâmico…, Contagem ou total…, Tabela dinâmica…, Matriz…, Referência cruzada…, Símbolo…, e Atualizar figuras de diagrama quando o texto tem imagens de diagrama
✦Ferramentas de texto com IA (veja abaixo)
¶ ▾Estilo de parágrafo: Texto, Título 1 a Título 4, Citação, Bloco de código
N / I / SNegrito (⌘B / Ctrl+B), itálico (⌘I / Ctrl+I), sublinhado (⌘U / Ctrl+U)
⋯Sublinhado (⌘U / Ctrl+U), Tachado, Sobrescrito, Subscrito, Código embutido, Realce, Limpar formatação (⌘⇧M / Ctrl+Shift+M)
• / 1.Lista com marcadores (⌘⇧8 / Ctrl+Shift+8) / lista numerada (⌘⇧7 / Ctrl+Shift+7)
⇤ / ⇥Recuar à esquerda (⌘[) / recuar (⌘])
≡ ▾Alinhamento: Esquerda, Centro, Direita, Justificar
▦Inserir tabela… e, dentro de uma tabela, as operações de tabela
🔗Link (⌘K / Ctrl+K)
AAmostras de Cor do texto e de Fundo (dez cores cada) e Remover cor
AaFonte (Arial, Brush Script MT, Comic Sans MS, Garamond, Georgia, Helvetica, Impact, monospace, Times New Roman) e Tamanho (10 a 60 px) para a seleção
↶ / ↷Desfazer (⌘Z / Ctrl+Z) / refazer (⇧⌘Z / Ctrl+Shift+Z) dentro do editor
</>Código-fonte HTML (⌘/ / Ctrl+/); o código-fonte é higienizado quando você volta
⤢Tela cheia; Esc sai primeiro da tela cheia
✓Salvar (⌘↵ / Ctrl↵)

Fonte, tamanho e estilos que envolvem a seleção precisam de uma seleção. Sem uma, a notificação diz "Selecione algum texto primeiro."

Tabelas

Inserir tabela pede Linhas (padrão 2), Colunas (padrão 3) e Linha de cabeçalho (ativada). Tab e Shift+Tab passam de uma célula a outra. Tab na última célula (ou Shift+Tab na primeira) sai do editor.

Dentro de uma tabela, clique em ▦ ou clique com o botão direito em uma célula para as operações de tabela:

  • Adicionar linha acima, Adicionar linha abaixo, Adicionar coluna antes, Adicionar coluna depois.
  • Adicionar linha de cabeçalho, Adicionar legenda, Mesclar com a célula à direita.
  • Excluir linha, Excluir coluna, Remover linha de cabeçalho, Remover legenda, Excluir tabela.

Imagens e arquivos

  • Imagem… insere um arquivo de imagem como figura. O diálogo Inserir imagem pede Texto alternativo (o que a imagem mostra), ou Decorativa (sem necessidade de texto alternativo) para uma imagem que não acrescenta informação.
  • Você também pode colar uma imagem, ou soltar um arquivo de imagem no editor. Essas começam sem texto alternativo; a notificação diz "Imagem adicionada sem texto alternativo. Adicione-o com o menu + (Texto alternativo…)."
  • Colar o endereço de uma imagem (terminado em .png, .jpg, .jpeg, .gif ou .webp) insere a imagem.
  • As imagens com mais de 4.000 px no lado maior são reduzidas para caber. O aviso diz "Imagem reduzida para L × A px (o limite é 4000 px no lado maior)."
  • Um arquivo de imagem acima do limite por arquivo é redesenhado com 1.600 px de largura em JPEG. Se ainda for grande demais, a notificação diz "A imagem excede o limite de N MB."
  • Arquivo… anexa qualquer arquivo como link de download, com um ícone para o tipo dele. Os arquivos acima do limite mostram "O arquivo excede o limite de N MB."

Texto alternativo

O texto alternativo descreve uma imagem para leitores de tela e na verificação de acessibilidade do Word.

  • + → Texto alternativo… lista cada imagem do texto com seu texto alternativo e uma caixa Decorativa. Ele avisa quando uma imagem não tem texto alternativo ou quando o texto alternativo é um nome de arquivo.
  • Clique duas vezes em uma imagem, ou clique com o botão direito nela e escolha Editar texto alternativo…, para editar só essa.
  • As imagens de diagrama (Diagrama…) recebem o texto alternativo da legenda: o tipo de diagrama e o nome da entidade.
  • A saída Word grava o texto alternativo na descrição de cada imagem. Uma imagem decorativa é marcada como decorativa.
  • Link… (Inserir link) recebe uma URL e um Texto. Os endereços sem http:, https:, mailto: ou # recebem https://. Os links abrem em uma nova aba.
  • Link para documento… (Inserir link de documento) cria um link para outro documento. Ele recebe um Documento, uma Versão (Atual ou Linha de base: {name}) e um Texto.
    • Na saída Word, os documentos vinculados dessa forma podem ser acrescentados como apêndices.
    • Sem outros documentos, a notificação diz "Este projeto não tem outros documentos. Crie um primeiro."

Conteúdo dinâmico

O conteúdo dinâmico fica em dia com o modelo onde quer que o texto seja mostrado: no documento, no inspetor, nas exportações e na pesquisa.

  • Diagrama… (Inserir diagrama): escolha o Tipo de diagrama e a entidade (ou um quadro branco ou um quadro). Ele insere uma imagem do diagrama, com legenda, vinculada ao diagrama.
    • A imagem é dinâmica. Quando o modelo muda, o documento mostra a nova imagem depois de um momento, e o Word e as outras exportações a desenham de novo.
    • Para manter a imagem atual, clique duas vezes na figura no editor (Figura de diagrama) e desative Atualizar a imagem quando o modelo mudar. A figura passa a ser um instantâneo.
    • Atualizar figuras de diagrama (em +) redesenha agora todas as figuras dinâmicas do texto.
    • Quando a entidade do diagrama é excluída, a figura mantém sua última imagem.
  • Valor dinâmico…: escolha uma entidade e um Atributo. O editor mostra o "Valor dinâmico" dele. Para alterar o atributo, clique duas vezes no valor dinâmico (Editar valor dinâmico).
  • Contagem ou total… insere um número recalculado a partir do modelo, para um resumo executivo ou uma linha de status como "12 de 40 requisitos estão verificados" (duas contagens). Seus campos:
    • Consulta: quais entidades contar, por exemplo class:Requirement AND Requirement:"Status=Approved". Veja sintaxe de pesquisa.
    • Escopo: Projeto inteiro, este documento ou outro documento. Uma compilação como escopo abrange todas as suas partes.
    • Função: Contagem, Soma, Média, Mínimo ou Máximo. Todas, exceto Contagem, pedem um Atributo numérico, como o Amount de um Cost. Sem números a totalizar, o valor é N/A.
    • O valor atual. Para alterar uma contagem depois, clique duas vezes nela.
  • Matriz… insere uma RTM, RVTM, VCRM, matriz de alocação ou outra matriz dinâmica. Veja Geração de documentos.
  • Tabela dinâmica… insere uma tabela de entidades a partir de uma consulta. As linhas são recalculadas sempre que o texto é mostrado ou exportado. Seus campos:
    • Consulta, por exemplo class:Requirement AND label:"Functional Requirement". O padrão é order:modified-. Veja sintaxe de pesquisa.
    • Escopo: Projeto inteiro, este documento, ou outro documento ou compilação.
    • Colunas (em ordem): padrão Número, Nome. + Adicionar atributo… adiciona uma coluna de atributo. + Adicionar coluna de relacionamento… adiciona uma coluna que lista as entidades relacionadas, por exemplo Verificado por.
    • Limite: padrão 10. Todas as linhas lista todas as correspondências.
    • Uma pré-visualização de até 50 linhas.
    • Para alterar uma tabela dinâmica depois, clique duas vezes nela.
  • Intervalo da planilha… insere células de uma planilha como tabela, ou como gráfico de um tipo que você escolhe (ou um dos gráficos da própria planilha), com legenda. Escolha a planilha, a aba e o intervalo e, opcionalmente, uma visão compartilhada a seguir. A tabela e o gráfico mostram os valores atuais e se atualizam quando as células mudam; o Word e as outras exportações usam os valores do momento da exportação. Quando o intervalo é excluído, a tabela mantém suas últimas linhas e é marcada como ausente.
  • Referência cruzada… (Inserir referência cruzada) se refere a uma parte do documento aberto pelo número atual dela:
    • Seção ou item mostra o número e o nome do item, por exemplo "3.2 Frost Warning". Outra entidade… escolhe uma entidade fora do documento.
    • Figura e Tabela listam as figuras e tabelas do documento que têm legenda, como "Figura 2" ou "Tabela 1". Escolher uma que ainda não tem chave de referência acrescenta uma chave a ela.
    • O texto acompanha a renumeração. Na saída Word, as referências cruzadas viram campos que o Word atualiza com os números das legendas. Uma referência cruzada cujo destino foi excluído mantém seu texto e é marcada.
  • Símbolo… insere um destes: ± ° µ Ω ≈ ≠ ≤ ≥ × ÷ √ ∞ ∑ π Δ, setas, • … — –, © ® ™ § ¶, € £ ¥ ¢, ½ ¼ ¾ ² ³, ✓ ✗.

Ferramentas de texto com IA

✦ reescreve a seleção, ou o parágrafo atual quando nada está selecionado. Sem nada em que trabalhar, a notificação diz "Não há texto para reescrever."

As ferramentas:

  • Melhorar a redação, Simplificar, Corrigir ortografia e gramática, Encurtar, Adicionar detalhe, Completar a frase.
  • Reescrever em um tom…: Acadêmico, Assertivo, Casual, Confiante, Construtivo, Empático, Empolgante, Fluente, Formal, Amigável, Inspirador, Profissional.
  • Traduzir… e Traduzir o texto inteiro…: árabe, chinês, inglês, francês, alemão, grego, italiano, japonês, coreano, português, russo, espanhol, sueco, ucraniano.
  • Escrever com IA….

A pré-visualização mostra Atual, Sugerido e Alterações. Escolha Substituir, Tentar novamente ou Descartar.

Colar

O texto formatado colado mantém sua estrutura: títulos, listas, tabelas e links. Ele perde classes, estilos embutidos (exceto em células de tabela) e marcações do Office. Scripts, frames e links inseguros são removidos de todo texto formatado.

Atalhos do texto formatado

TeclasAção
⌘↵ / Ctrl↵Salvar e fechar
EscCancelar (ou sair da tela cheia)
⌘B / Ctrl+B / ⌘I / Ctrl+I / ⌘U / Ctrl+UNegrito / itálico / sublinhado
⌘K / Ctrl+KLink
⌘⇧7 / Ctrl+Shift+7 / ⌘⇧8 / Ctrl+Shift+8Lista numerada / com marcadores
⌘] / ⌘[Recuar / recuar à esquerda
Tab / Shift+TabCélula seguinte / anterior da tabela; em outros lugares, sair do editor (ele salva)
⌘⇧M / Ctrl+Shift+MRemover formatação
⌥⌘0 / Ctrl+Alt+0Parágrafo de texto
⌥⌘1 / Ctrl+Alt+1 a ⌥⌘4 / Ctrl+Alt+4Título 1 a Título 4
⌘/ / Ctrl+/Código-fonte HTML
⌘Z / Ctrl+Z / ⇧⌘Z / Ctrl+Shift+ZDesfazer / refazer no editor

Localizar no documento

Clique em Localizar ou pressione ⌘F / Ctrl+F para pesquisar no documento. A caixa de pesquisa mostra "n de m".

A pesquisa abrange o número, o nome e a descrição de cada item, os valores das colunas exibidas e as mensagens da checagem de qualidade. Ela ignora os itens ocultos por um filtro.

  • Enter ou ▼ vai para a próxima correspondência.
  • Shift+Enter ou ▲ vai para a correspondência anterior.
  • Esc limpa o texto, e × fecha a caixa.

As seções recolhidas se abrem para mostrar uma correspondência. As linhas correspondentes ficam destacadas, e a atual fica marcada.

Localizar e substituir

Escrever ▾ → Localizar e substituir… abre Localizar e substituir. Ele tem:

  • Localizar e Substituir.
  • Os campos a pesquisar: Nome, Número e Descrição. Número fica desativado por padrão.
  • Diferenciar maiúsculas e minúsculas e Somente palavras inteiras.

A linha abaixo dos campos diz "N entidades correspondem (as entidades bloqueadas são ignoradas)." Substituir tudo altera todas as correspondências nos itens do documento, e um único Desfazer reverte tudo. A notificação diz "N entidades atualizadas", ou "Nenhuma correspondência". No texto formatado, só o texto muda: formatação, links e notações ficam intactos.

Menu Escrever

Escrever ▾ contém os comandos que adicionam e alteram conteúdo. Os comandos que adicionam itens ficam esmaecidos em uma linha de base, com acesso somente de visualização e enquanto um filtro ou uma ordenação está ativo; a dica dá o motivo.

ItemO que ele faz
Adicionar item ▸As classes Statement e Outra classe…. Adiciona o item depois do selecionado, ou no fim sem nada selecionado. A classe escolhida passa a ser a classe atual.
Adicionar item existente…Veja Entidades existentes.
Inserir ▸Conteúdo dinâmico na descrição do item selecionado: Valor dinâmico…, Contagem ou total…, Tabela dinâmica…, Matriz…, Imagem de diagrama…, Intervalo da planilha… e Referência cruzada…. O editor de descrição abre no fim do texto com o diálogo escolhido (veja Conteúdo dinâmico). Esmaecido até que um item desbloqueado esteja selecionado ("Selecione primeiro um item desbloqueado"). Em uma compilação, ele também oferece Documento… e Seção gerada… (veja Compilações).
✦ Gerar requisitos…Gerador de IA, sob o item selecionado ou para o documento inteiro. Todo resultado é pré-visualizado antes de ser adicionado.
✦ Gerar requisitos filhos…Com um Statement ou requisito selecionado: novos filhos dele.
✦ Gerar riscos…Com um item selecionado: riscos para ele.
✦ Gerar caso de teste…Com um requisito selecionado: um caso de teste que o verifica.
✦ Resumir…Escreve um item de resumo, mantido em primeiro lugar no documento, sem número.
✦ Traduzir…Traduz o texto do documento, com pré-visualização.
Localizar e substituir…Veja Localizar e substituir.
Renumerar…Veja Renumerar.
Modelos ▸Aplicar modelo… (Aplicar um modelo), Salvar como modelo… (Salvar um documento como modelo) e Gerenciar modelos… (Gerenciar modelos).

Definir atributo neste ramo

Clique com o botão direito em um item e escolha Definir atributo neste ramo… para definir um valor no item e em todos os seus descendentes. Escolha Adicionar rótulo, Remover rótulo ou um atributo, e depois o valor. O diálogo informa "Aplica-se a {item} e a seus N descendentes. As entidades bloqueadas são ignoradas." A notificação diz "N entidades atualizadas (k bloqueadas ignoradas)".

Dividir em vários itens

Clique com o botão direito em um item e escolha Dividir em vários itens… para quebrar um requisito composto em requisitos singulares. O diálogo se intitula Dividir em vários itens: {item}.

  1. Escolha Cortar nas frases ou Cortar nos parágrafos, e Novos itens como filhos dele ou Novos itens depois dele.

    A tabela mostra um item proposto por parte, com seu número, um Nome e um Texto editáveis.

  2. Ou clique em ✦ Propor uma divisão para que a IA proponha requisitos singulares (até 20).
    • As linhas cujo texto contém um endereço web começam desmarcadas.
    • Quando o original está aprovado, em linha de base ou bloqueado, substituir o texto dele é uma opção desmarcada.
    • Uma comparação mostra a linha 1 em relação ao original.
  3. Edite nomes e texto. Unir junta uma parte com a seguinte.
  4. Desmarque as partes que você não quer e clique em Aplicar.

A parte 1 ("mantém") fica no item original. Cada parte marcada vira um novo item da mesma classe com os mesmos rótulos. Os números são propostos automaticamente; com a renumeração automática ativada, eles são reatribuídos após a divisão. Um único Desfazer reverte a divisão inteira; a notificação diz "Dividido em N itens".

Menu Checar

Checar ▾ lista o que requer atenção neste documento, com contagens à direita:

ItemO que ele faz
Checar qualidadeCheca todos os requisitos do documento que passam pelo filtro atual e abre os resultados. Com um requisito selecionado, o item é Checar a qualidade deste requisito. Sem requisitos: "Este documento não tem Requirements a checar. Statements não são pontuados."
Checagens do modelo para este documento…Abre Checagens do modelo para este documento: as constatações das Checagens do modelo para o documento e seus itens (regra, item, constatação) e o conteúdo dinâmico que aponta para algo ausente. Clique em um item para selecioná-lo. Sem nenhuma: "Nenhuma constatação para este documento." Abrir checagens do modelo abre a página para o projeto inteiro.
Status de rastreamento…Mostra "N de M completos" e abre Status de rastreamento: os requisitos ainda não alocados ou verificados, cada um com seu ponto e o que falta (satisfied by, verified by). Clique em um para selecioná-lo. Abrir a RVTM abre a página da RVTM. Mostrado quando o documento tem requisitos.
Vínculos a revisarAbre Vínculos a revisar para este documento.
Registro de TBD/TBRAbre o registro de TBD/TBR para este documento.
Encontrar acrônimos…Veja Encontrar acrônimos.
ComentáriosMostra o número de comentários em aberto e os abre no inspetor (veja Comentários).

Status de rastreamento

Um ponto após os selos de cada requisito mostra seu status de rastreamento:

  • Verde: o requisito é satisfied by algo (alocado) e verified by algo.
  • Âmbar: falta um dos dois.
  • Vermelho: nenhum dos vínculos existe.

Aponte para o ponto para ver o status e o que falta, por exemplo "Status de rastreamento: parcialmente rastreado. Falta: nenhum vínculo verified by (não verificado)." Clique nele para um menu com os itens em Satisfied by (alocação) e Verificado por (clique em um para abri-lo), Abrir na RVTM e Relacionar com ▸. Statements e outras classes não têm ponto. Em uma linha de base, os pontos mostram os vínculos da linha de base. Desative os pontos com Exibir ▾ → Status de rastreamento.

Encontrar acrônimos

Checar ▾ → Encontrar acrônimos… encontra os acrônimos nos números, nomes e descrições do documento e os adiciona à seção Glossary dele, em uma única lista de revisão.

  • Um acrônimo tem duas ou mais maiúsculas, até oito caracteres, e não é composto só de dígitos.
  • A expansão vem da entrada existente do projeto, ou das palavras ao lado do termo cujas iniciais o formam ("Concept of Operations" → CONOPS).
  • Cada linha tem Manter, o Termo, a Expansão e seus Usos (clique em "N usos" para ver cada lugar em que ele aparece). Uma nota marca os termos que já estão "no glossário", que têm uma "entrada existente no projeto", ou sem "nenhuma expansão encontrada".
  • Os termos com expansão que ainda não estão no glossário começam marcados. A caixa do cabeçalho marca ou desmarca todos.
  • Vincular cada uso no texto à entrada do glossário (valor dinâmico) (ativado) transforma cada uso nas descrições em um valor dinâmico do número da entrada, vinculado à entrada.

Clique em Adicionar ao glossário. Cada termo marcado vira um Statement com o rótulo Acronym, com Número = termo e Nome = expansão, sob a seção de nível superior Glossary do documento (uma seção existente chamada Glossary ou Acronyms é usada; caso contrário, uma é adicionada no fim). Uma entrada que já está no projeto é reutilizada em vez de criar uma segunda. Um único Desfazer reverte tudo. Sem nada encontrado, você vê "Nenhum acrônimo neste documento. Acrônimos são palavras com duas ou mais letras maiúsculas, como CONOPS."; sem nada marcado, "Marque pelo menos um termo." A renumeração não mexe nas entradas do glossário.

Menu Entregar

Entregar ▾ configura o entregável e o exporta, agrupado por saída:

ItemO que ele faz
Configuração do entregável…Numeração, folha de rosto, cabeçalho contínuo e bloco de assinaturas (veja Configuração do entregável).
Configurar página…Marcação, capa e números de página (veja Formato da página).
Modelo Word ▸Os modelos Word, com um ✔ no que este documento usa, e Editar modelos Word…. Escolher um o torna o modelo deste documento.
Versão ▸Salvar linha de base… e Comparar versões… (veja Linhas de base).
Word: um {template} (Word) por modelo WordBaixa o documento em Word na hora com as opções desse modelo; o próprio modelo do documento mostra "este documento". A partir de uma linha de base, a saída é a linha de base.
Estrutura (Word)…A estrutura como títulos, opcionalmente com um sumário.
Redline (Word)…Veja Redline. Exige uma linha de base.
Excel: Matriz de rastreabilidade…Uma matriz padrão como Excel, Word, CSV ou página web (veja Geração de documentos).
Alterações (Excel)…Mudanças de uma linha de base para outra posterior ou para a versão atual. Exige uma linha de base.
Intercâmbio: Requisitos (ReqIF)…, Dados do documento (JSON)…Formatos de intercâmbio (veja Relatórios).
Imprimir ou PDF…Veja Imprimir / PDF.
Todas as exportações…Todas as exportações com suas opções (veja Relatórios).

Modelos do Word

Um modelo Word é um conjunto nomeado de opções de exportação para Word e da página. Ele molda o arquivo Word, não o conteúdo (os modelos de documento preenchem o conteúdo; veja Modelos). Cada documento usa um; o padrão é Especificação. Escolha-o em Entregar ▾ → Modelo Word ▸.

Modelos integrados:

ModeloOpções
EspecificaçãoSumário até o nível 3, legendas numeradas, listas de figuras e de tabelas, histórico de revisões e aprovações a partir das linhas de base, documentos vinculados como apêndices. Colunas de atributo quando o documento mostra alguma.
Entregável por capítuloComo Especificação, com as legendas numeradas por capítulo (Figura 3-1) e os títulos de dentro das descrições no sumário.
Cópia de revisãoPáginas em paisagem com as colunas de atributo do documento sob cada item; sumário até o nível 2, sem tabelas pré-textuais.
SimplesTítulo, títulos de seção e texto: sem sumário, números de legenda ou tabelas pré-textuais.

Todos os modelos integrados usam páginas Letter.

Editar modelos Word… abre Modelos Word. Os modelos integrados têm Copiar; uma cópia vira um modelo do projeto, guardado no projeto para todos os membros. Selecione um modelo do projeto para alterar:

  • Nome, Tamanho da página (Letter (8.5 × 11 in) ou A4 (210 × 297 mm)) e Orientação (Retrato ou Paisagem).
  • Sumário (Nenhum, Nível 1, Níveis 1–2, Níveis 1–3, Níveis 1–4, Todos os níveis) e Numeração de legendas (Figura 1, Tabela 1, Por capítulo: Figura 3-1 ou Desativada).
  • Lista de figuras e lista de tabelas (quando há legendas), Títulos dentro das descrições aparecem no sumário, As colunas de atributo mostradas no documento, sob cada item, Documentos vinculados como apêndices e Histórico de revisões e aprovações a partir das linhas de base.
  • Excluir modelo.

Clique em Salvar (um único Desfazer reverte; a notificação diz "Modelos Word salvos."). Um documento cujo modelo foi excluído volta para Especificação.

Arquivos Word da empresa

Um modelo do projeto pode levar o arquivo Word da sua organização (.docx ou .dotx, até 5 MB). A exportação então usa do arquivo:

  • Estilos: fontes, cores, estilos de título e de corpo. Os estilos que faltam no arquivo (legendas, entradas do sumário) são adicionados; a numeração de títulos do arquivo é descartada, porque o Holarch numera os títulos.
  • Página: tamanho, orientação e margens. Escolher o arquivo ajusta o Tamanho da página e a Orientação do modelo para corresponder.
  • Cabeçalhos e rodapés, com seus logotipos e números de página. A marcação do projeto ou do documento é adicionada a cada um.
  • Folha de rosto: o conteúdo do arquivo antes da primeira quebra de seção, ou o arquivo inteiro quando ele não tem nenhuma. Ela substitui a folha de rosto do Holarch.

Na folha de rosto e nos cabeçalhos e rodapés, estes marcadores são preenchidos: {{Title}}, {{Type}}, {{Number}}, {{Version}}, {{Date}}, {{Project}}, {{Organization}}, {{Contract}}, {{CDRL}}, {{Prepared For}}, {{Prepared By}} e {{Baseline}}. Maiúsculas e espaços não importam. Outros textos entre chaves ficam como escritos.

Para adicionar um:

  1. Escolha Entregar ▾ → Modelo Word ▸ → Editar modelos Word….
  2. Clique em Escolher… na linha Arquivo Word da empresa, ou selecione um modelo do projeto e clique em Escolher… em Arquivo Word da empresa.
  3. Escolha o arquivo. Clique em Salvar.

Substituir… troca o arquivo e Remover volta aos estilos e à folha de rosto do Holarch. Um arquivo que não é um documento Word é recusado com "O arquivo não é um documento Word (.docx ou .dotx)." O conteúdo que aponta para fora do documento fica de fora: imagens vinculadas, objetos e controles incorporados, e campos INCLUDETEXT, INCLUDEPICTURE, DDE, LINK e IMPORT. Macros nunca são lidas.

A página do modelo também define a largura da visão Papel: as páginas Letter têm 816 px de largura, A4 794 px, mais largas em paisagem. Em Todas as exportações… → Documento (Word), as opções partem do modelo do documento; ali, Modelo Word as preenche a partir de outro, e você pode alterá-las para uma única exportação.

Menu Exibir

Exibir ▾ contém alternâncias diretas para este documento:

  • Papel (✔ quando ativado): mostra o documento como páginas, com a largura da página do modelo Word, sem colunas de atributo. Os Requirements Documents começam com ele desativado; os outros tipos começam com ele ativado.
  • Painel de estrutura: mostra ou oculta o painel da estrutura.
  • Status de rastreamento: mostra ou oculta os pontos de status de rastreamento. Ativado por padrão.
  • Colunas ▸ (esmaecido na visão Papel): todos os atributos das classes do documento e os campos do item (Classe, Número, Criado em, Modificado em, Rótulos), com um ✔ nas colunas mostradas. Escolha uma para mostrá-la ou ocultá-la; uma nova coluna vai para o fim. Colunas padrão restaura Status, Método de verificação e Pontuação de qualidade.
  • Recolher tudo, e Expandir tudo quando algo está recolhido.
  • Recolher filhos: recolhe as seções sob o item selecionado (esmaecido até que um item com subseções esteja selecionado).
  • Redefinir visualização: limpa recolhimentos, filtros, ordenação e pesquisa. Também mostra o painel da estrutura na largura padrão, redefine as larguras das colunas e restaura as colunas padrão.
  • Abrir em ▸: abre o item selecionado, ou o documento quando nada está selecionado, em outra visão: Visão do item, Histórico… (todas as mudanças registradas, com uma comparação palavra a palavra por campo), os diagramas que podem mostrá-lo, Matriz de rastreabilidade (o documento como eixo das linhas), Qualidade dos requisitos (com o escopo do documento) e Análise funcional.
  • Ajuda.

Clique com o botão direito no cabeçalho de uma coluna para Mover para a esquerda, Mover para a direita e Ocultar coluna.

As colunas são lembradas por documento neste navegador. A última escolha é o ponto de partida para os documentos que você ainda não configurou. Papel e Status de rastreamento são salvos com o documento. A posição da rolagem horizontal permanece onde está quando você seleciona uma linha.

Linhas de base

Versão ▾ no bloco de título lista Versão atual, as linhas de base deste documento e, em Linhas de base do projeto, as linhas de base do projeto (cada uma com sua data; um ✔ marca a que está sendo mostrada). A lista termina com Salvar linha de base… e Comparar versões…. Entregar ▾ → Versão ▸ tem os mesmos dois comandos.

Criar uma linha de base

  1. Clique em Versão ▾ → Salvar linha de base… (esmaecido enquanto uma linha de base é mostrada: "Volte primeiro à versão atual").

    Salvar linha de base abre com 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 são datados agora e não podem ser editados depois."

  2. Digite o Nome (obrigatório). O padrão é "{document} Linha de base N".
  3. Em Aprovações, preencha uma linha por aprovador: Nome, Função e Declaração. A primeira linha vem preenchida com o seu nome. A declaração padrão é "Aprovado para liberação."
  4. Clique em + Adicionar aprovador para mais linhas, ou em × para remover uma. Linhas sem nome são ignoradas.
  5. Clique em Criar.

    A notificação diz "Linha de base salva".

Ver uma linha de base

Escolha uma linha de base em Versão ▾. O banner diz "Linha de base “{name}”, somente leitura, salva em {date}" (com "· linha de base do projeto" para uma linha de base do projeto), com os aprovadores. Ele oferece:

  • Voltar à versão atual: volta à cópia de trabalho.
  • Editar (linhas de base do documento): abre Editar linha de base. Renomeie a linha de base ou adicione registros de aprovação em Adicionar aprovações. "Os novos registros são datados agora e adicionados à lista. Os registros existentes não podem ser alterados."
  • Comparar com a versão atual (linhas de base do documento): abre Comparar versões a partir desta linha de base.
  • Restaurar linha de base: pergunta "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). É possível desfazer."
    • Para uma linha de base do projeto, abre Substituir projeto pela linha de base: "Substituir o projeto inteiro pela linha de base do projeto "{name}"? É possível desfazer."
  • Excluir: pergunta "Excluir a linha de base "{name}"?"

Em uma linha de base, a edição, a adição rápida e as ferramentas de estrutura ficam desativadas, e a estrutura mostra 🔒. Entregar ▾ produz as saídas a partir da linha de base ("Exportar (linha de base “{name}”)").

O conteúdo dinâmico em uma linha de base mostra o modelo da linha de base, na tela e nas saídas: valores dinâmicos, contagens e totais, tabelas dinâmicas, matrizes e referências cruzadas são resolvidos com base no instantâneo, e as figuras de diagrama mantêm as imagens guardadas com a linha de base. Uma linha de base do documento contém o documento, seus itens e as entidades a um relacionamento de distância, então uma contagem ou tabela nela cobre essas entidades; um valor dinâmico de uma entidade fora da linha de base mostra o valor atual.

Comparar versões

Versão ▾ → Comparar versões… abre Comparar versões. Ele compara De (uma linha de base) com Para: uma linha de base posterior ou a Versão atual. Sem linhas de base, mostra "Este documento não tem linha de base. Salve uma primeiro."

Ele lista "N alterações", com Número, Nome, Tipo de alteração, Campo e Alteração. Para texto modificado, Alteração mostra uma diferença palavra a palavra.

Tipos de alteração:

  • Adicionado e Removido.
  • Modificado: o campo é Nome, Número, Descrição, Classe, Imagem ou qualquer atributo.
  • Rótulo adicionado e Rótulo removido.
  • Relacionamento adicionado, Relacionamento removido e Atributo de relacionamento.

Alterações (Excel) baixa a comparação com Número, Nome, Classe, Tipo de alteração, Campo, Valor antigo e Valor novo. Redline (Word) baixa a mesma comparação como um redline do Word (veja Redline).

Relatórios

Entregar ▾ exporta o documento para Word, PDF, planilhas e outros formatos. Os itens {template} (Word) são baixados na hora (veja Modelos Word); cada item Word tem uma descrição de uma linha sob o nome. Excluir documento…, no fim do menu, exclui o documento, opcionalmente com as seções que nenhum outro documento usa (veja A lista de documentos), e depois volta à lista. Estrutura (Word)…, Redline (Word)…, Alterações (Excel)…, Requisitos (ReqIF)…, Dados do documento (JSON)… e Imprimir ou PDF… abrem a caixa de diálogo Exportar com essa escolha; Todas as exportações… a abre com a sua última escolha.

  1. Clique em Entregar ▾ → Todas as exportações….

    Exportar abre.

  2. Escolha o que exportar em Exportar como. As opções se chamam "<conteúdo> (<formato>)" e são agrupadas por saída: Word, Excel, CSV, Página web, Texto, Intercâmbio e Impressão.
  3. Defina as opções.
  4. Edite o Nome do arquivo (até 99 caracteres).
  5. Clique em Exportar.

Pré-visualização mostra as primeiras 60 linhas dos relatórios em planilha. Para outras exportações, mostra "A pré-visualização mostra apenas exportações em planilha. Escolha uma exportação Excel." Os relatórios usam os números do documento e, em uma linha de base, o conteúdo da linha de base.

RelatórioSaídaOpções
Documento (Word)O documento em Word (veja Saída Word)Modelo Word (o do documento; escolher outro preenche as opções abaixo a partir dele), Adicionar um sumário, Profundidade do sumário de 1 a 6, Numeração de legendas (Figura 1, Tabela 1, Por capítulo: Figura 3-1, Tabela 3-1 ou Desativada), Lista de figuras e lista de tabelas (quando o documento tem legendas), Títulos dentro das descrições aparecem no sumário, Incluir as colunas de atributo mostradas no documento, Adicionar documentos vinculados como apêndices, Preencher as tabelas de histórico de revisões e de aprovações a partir das linhas de base. Os padrões vêm do modelo; com Especificação: sumário até o nível 3, numeração simples de legendas, listas, colunas quando mostradas, apêndices e as tabelas de linha de base ativados, títulos desativados. O tamanho e a orientação da página são os do modelo.
Alterações (Excel)Cada item, atributo e relacionamento adicionado, removido e alterado entre duas versõesDe (uma linha de base, a mais antiga selecionada primeiro), Para (Versão atual ou uma linha de base); "Este documento não tem linha de base. Salve uma primeiro." quando não há nenhuma
Tabela (CSV)Uma linha por itemAtributos (na ordem das colunas) (padrão Número, Nome, Descrição e as colunas exibidas; também qualquer Relacionamento: {name}, listando os itens relacionados), Ordenar por Hierárquico, Número ou Nome
Comentários (Excel)Uma linha por comentário no documento e em seus itens, com o autor do comentárioIncluir Classe, Nome, Número e Descrição, Data, Resolvido (todos ativados)
Dados do documento (JSON)O documento para reimportaçãoEntidades diretamente relacionadas (desativado), Comentários (ativado), Linhas de base (desativado), Histórico (desativado)
Estrutura (Word)Apenas títulos, numeradosAdicionar um sumário (desativado)
Documento (Markdown)O documento como títulos e texto em Markdownnenhuma
Documento (Imprimir ou PDF)A caixa de diálogo de impressão do navegador; escolha Salvar como PDF nelanenhuma
Redline (Word)O documento com alterações controladas do Word (veja Redline)Da linha de base (a mais recente), Destino (uma linha de base posterior ou Atual)
Constatações de qualidade (Excel)Nove linhas por requisito (uma por critério) com a mensagem e um Sim verde ou um Não vermelho, e uma "Pontuação do relatório" finalMais atributos, Incluir Criado em, Modificado em e ID global
Requisitos (ReqIF)ReqIF XML com a hierarquia e os vínculos traced to, satisfied by, verified by, satisfies, verifies e traced from dentro do documentonenhuma
RSM (Excel)Requirement → itens satisfied byAtributos do requisito (Número, Nome), Atributos da entidade relacionada (Classe, Número, Nome, Descrição)
RTM (Excel)Requirement → itens traced tocomo RSM
RVM (Excel)Requirement → itens verified bycomo RSM
RVTM (Excel)Requirement → Test Cases que o verificam, com todas as linhas do documento incluídasAtributos do requisito (Número, Nome, Descrição, Método(s) de verificação), Atributos de Test Case (Número, Nome, Descrição, Status)
TVM (Excel)Test Cases do documento → os requisitos que eles verificamAtributos de Test Case (Número, Nome, Status), Atributos do requisito (Número, Nome, Descrição)
VCRM (Excel)Requisitos × métodos de verificação com um XAtributos do requisito (Número, Nome), Métodos de verificação (todos)
Matriz de rastreabilidade (Excel), (Word), (CSV), (HTML)Uma matriz padrão do documento ou do projeto inteiro (veja Geração de documentos)Matriz, Escopo (Este documento ou Projeto inteiro)

Nos relatórios de matriz:

  • Um requisito sem item vinculado fica sombreado em vermelho. Na VCRM, um requisito sem método fica sombreado em vermelho.
  • As células do requisito são mescladas sobre as linhas relacionadas.
  • As duas linhas de cabeçalho ficam congeladas.

Saída Word

Documento (Word) monta um arquivo Word nesta ordem:

  1. A folha de rosto (com Capa ativada em Configurar página, ou Folha de rosto em Configuração do entregável), ou então o título e uma linha em itálico com o tipo e "Nº {number}". A partir de uma linha de base, a linha acrescenta "Linha de base: {name} ({date})". Um aviso de marcação (Configurar página) aparece em uma caixa sob o título.
  2. Histórico de revisões (Versão, Data, Autor, Alterações): uma linha por linha de base do documento, da mais antiga para a mais recente, até a linha de base exportada.
    • A primeira linha diz "Linha de base inicial". As linhas seguintes dizem "N adicionados, N removidos, N modificados" ou "Sem alterações".
    • O autor é quem criou a linha de base ou os aprovadores dela.
  3. Aprovações (Função, Nome, Declaração, Data), da linha de base mais recente (ou da exportada). Sem registros de aprovação, os aprovadores planejados na Configuração do entregável recebem um bloco de assinatura: Função, Nome, Assinatura e Data, com linhas em branco para assinar.
  4. A descrição do documento, depois o sumário, a Lista de figuras e a Lista de tabelas, e uma quebra de página.
  5. Cada item como um título do Word com seu número e nome, seguido da descrição. Título 1 a Título 6 acompanham a profundidade; níveis mais profundos ficam em Título 6. Uma tabela Atributo/Valor lista as colunas escolhidas que têm valor.
  6. Apêndices: cada documento vinculado por um vínculo incorporado começa em uma nova página com "Apêndice {document}" e seu conteúdo, um nível abaixo.

As tabelas geradas podem ir para uma seção em vez do topo. Isso acontece quando o documento tem uma seção com um destes nomes (os modelos internos os usam):

  • Histórico de revisões: "Revision History" ou "Document Revision History".
  • Aprovações: "Approvals", "Approval", "Sign-off", "Signoff", "Signatures" ou "Signature".

Legendas, listas e referências cruzadas

  • Legendas de figuras (a legenda de uma imagem, uma figura de diagrama) dizem "Figura 1: {caption}" sob a imagem. Legendas de tabelas (o título de um bloco de matriz, a legenda de uma tabela) dizem "Tabela 1: {caption}" acima da tabela.
  • Por capítulo as numera por seção de nível superior: "Figura 3-1" é a primeira figura da seção 3. Tabelas sem legenda não são numeradas.
  • Os números são campos SEQ do Word, e a Lista de figuras e a Lista de tabelas são campos do Word sobre as legendas. Elas só aparecem quando o documento tem legendas de figura ou de tabela. Até o Word atualizar os campos, as listas mostram as legendas sem números de página.
  • Cada título, legenda de figura e legenda de tabela leva um indicador. Uma referência cruzada em uma descrição vira um campo REF do Word apontando para o indicador, então mostra o título atual ("3.2 Alerta de geada") ou o rótulo ("Figura 2-1") depois que o Word atualiza os campos. Uma referência cruzada para um item que não está no documento exportado mantém o seu texto.
  • Títulos dentro das descrições aparecem no sumário transforma os títulos de uma descrição em títulos reais do Word, um nível abaixo do item. Desativada, eles continuam como parágrafos em negrito.

Configuração do entregável

Entregar ▾ → Configuração do entregável… guarda os dados que um entregável contratual costuma mostrar. Aplicar os salva; ⌘Z / Ctrl+Z os desfaz em uma única etapa.

CampoOnde aparece
NumeraçãoNúmeros do modelo (os números próprios dos itens) (padrão) ou Números do documento (mantidos somente neste documento) (veja Numeração do documento).
Folha de rostoAtiva a folha de rosto (a mesma chave que Capa em Configurar página).
Versão, Preparado porFolha de rosto e cabeçalho corrente (os mesmos campos de Configurar página).
Organização, Preparado para, Número do contrato, Item CDRL, Número do DIDFolha de rosto. O item CDRL também aparece no rodapé corrente.
LogotipoTopo da folha de rosto. PNG, JPEG ou GIF, até 400 KB.
Aviso da folha de rostoUma caixa no pé da folha de rosto, por exemplo uma declaração de distribuição. Vazio: o aviso de marcação de Configurar página.
Cabeçalho e rodapé correntesAtivado por padrão. O cabeçalho mostra "{number}, Versão {version}" e o título; o rodapé mostra a data, "Página X de Y" e "CDRL {item}". Precisa de um número de documento ou de uma versão.
Aprovadores planejadosFunção e nome por aprovador. Eles recebem linhas de assinatura até que uma linha de base registre aprovações.

O número do documento é o campo Nº ao lado do título do documento.

Formato da página

  • A página do modelo Word: US Letter ou A4, retrato ou paisagem, com margens superior e inferior de 1 polegada e margens laterais de 0,875 polegada.
  • Calibri 11 pt.
  • Estilos de título reais, para que o painel de navegação e o sumário do Word funcionem.
  • As linhas de cabeçalho das tabelas são sombreadas e repetidas em cada página.
  • Os banners da página (marcações) se repetem no cabeçalho e no rodapé de todas as páginas, inclusive a folha de rosto.
  • Com uma folha de rosto, o arquivo tem três seções: a folha de rosto (só banners, sem cabeçalho corrente e sem número de página), os elementos pré-textuais (histórico de revisões, aprovações, descrição, sumário e listas, numerados i, ii, iii) e o corpo (numerado a partir de 1; "Página X de Y" conta o corpo).
  • O Word pede para atualizar os campos ao abrir o arquivo. Até lá, o sumário mostra "Clique com o botão direito e escolha Atualizar campo para montar o sumário."

Conversão do texto formatado

  • Mantidos: negrito, itálico, sublinhado, tachado, sobrescrito, subscrito, código em linha (Consolas), realce, cor do texto e links web.
  • Os títulos dentro das descrições viram parágrafos em negrito, ou títulos do Word com a opção acima.
  • As listas viram parágrafos recuados com "•" ou "1.".
  • Os blocos de código viram linhas monoespaçadas sombreadas. As citações viram texto recuado em itálico.
  • As tabelas mantêm as colunas mescladas e o sombreamento do cabeçalho.
  • As imagens PNG, JPEG e GIF são incorporadas, com até cerca de 6,5 polegadas de largura, com o texto alternativo como descrição da imagem. As imagens SVG e WebP ficam de fora dos arquivos Word.

Redline

Entregar ▾ → Redline (Word)… grava o documento com alterações controladas do Word. Escolha a Da linha de base e o Destino (uma linha de base posterior ou Atual). Redline (Word) em Comparar versões faz o mesmo para as duas versões mostradas ali.

  • O arquivo começa com uma tabela Resumo das alterações: todas as alterações do relatório de alterações, inclusive atributos, rótulos e relacionamentos.
  • Depois vem o documento na versão de destino: um item adicionado é uma inserção controlada; um item removido é uma exclusão controlada, colocada após o item que vinha antes dele; um nome ou uma descrição alterados mostram as palavras excluídas e inseridas.
  • Aceite ou rejeite as alterações na aba Revisão do Word. As descrições alteradas aparecem como texto simples; as inalteradas mantêm a formatação.
  • As alterações são atribuídas a quem criou a linha de base de destino, ou ao seu nome para Atual.

Imprimir ou PDF… imprime a página do documento pelo navegador. Os banners são impressos no topo e na base de cada página. Com um cabeçalho corrente (Configuração do entregável), "{number}, Versão {version}" e o título se repetem no topo de cada página, e a data e o item CDRL na base. Em uma compilação, cada parte começa em uma nova página. Números de página, sumário e numeração de legendas existem apenas na saída Word.

Comentários

Comente um item no painel da entidade no inspetor (a parte Discussão). Checar ▾ → Comentários, ou 💬 n comentários abertos no bloco de título, mostra os comentários no inspetor:

  • Todos os comentários do documento e de seus itens, agrupados por item, com "(N abertos)". As respostas ficam recuadas sob o comentário que respondem. Clique no nome de um item para selecioná-lo.
  • Mostrar resolvidos inclui os comentários resolvidos.
  • Cada conversa tem Resolver/Reabrir no primeiro comentário, e cada comentário tem × (excluir).
  • Para comentar o próprio documento, digite em Comentar este documento… e clique em Adicionar comentário.
  • × no topo fecha os comentários; selecionar um item mostra o painel da entidade dele.
  • Uma linha com comentários não resolvidos mostra 💬 n; clique nele para abrir a discussão do item.
  • Resolva, reabra e exclua comentários em qualquer um dos dois lugares.
  • Comentários (Excel) em Todas as exportações… os reúne.

Veja Comentários e revisões.

Compilações

Uma compilação reúne outros documentos. As novas, criadas na página Revisões ou por Criar pacote de revisão, recebem o rótulo Pacote de revisão; os pacotes criados antes recebem o rótulo Compilação e funcionam da mesma forma. Veja Revisões.

Inserir documento… adiciona um documento. Fica em Escrever ▾ → Inserir ▸ e no menu + Novo ▾.

  • Lista os documentos ainda não incluídos.
  • O documento inserido aparece como um item de nível superior, com o seu próprio conteúdo abaixo dele. O aviso diz "{document} inserido".
  • Sem outros documentos, você vê "Nenhum outro documento para inserir."

Seções geradas

Inserir seção gerada… (em Escrever ▾ → Inserir ▸ e no menu + Novo ▾) adiciona uma parte cujo conteúdo é reconstruído a partir do modelo sempre que a compilação é mostrada ou exportada.

ConteúdoO que a parte contém
Matriz ou Relatório de teste…Inserir abre Inserir matriz; escolha ali a matriz (ou um Relatório de teste) e o escopo. O escopo Compilação (todas as partes) cobre todas as partes. Deixe Nome da seção vazio para usar o nome da matriz.
Lista de siglasUma tabela das declarações com o rótulo Acronym (Número, Nome), ordenada por número.
Tabela de consultaUma tabela das entidades que correspondem à Consulta, com as Colunas que você listar (nomes de atributos, separados por vírgula).

A parte é numerada após a última parte, então os documentos das partes mantêm seus números. ⌘Z / Ctrl+Z a remove em uma única etapa. Sem nome, você vê "Digite um nome de seção."; uma tabela de consulta sem consulta ou colunas mostra "Digite uma consulta e pelo menos uma coluna."

Compilação no Word

A exportação Word de uma compilação exporta cada item de nível superior como uma parte:

  • O título da parte diz "Parte A: {document}" (Título 1), com uma linha para o tipo, o número e a linha de base fixada do documento.
  • Os números de seção dentro de uma parte recebem a letra da parte: "A.1 Escopo", "B.1 Escopo". Nenhum número de seção se repete.
  • Cada parte após a primeira começa em uma nova página.
  • Com legendas Por capítulo, as figuras da Parte B dizem "Figura B-1".

Configuração do entregável… em uma compilação adiciona Partes da compilação:

AjusteEscolhas
Rótulos das partesParte A, Parte B, … (padrão), Volume 1, Volume 2, …, Apêndice A, Apêndice B, … ou Sem rótulos de parte
Números de seçãoPor parte, com a letra ou o número da parte (A.1, B.1) (padrão), Contínua entre as partes (1, 2, 3) ou Cada documento mantém os próprios números
Iniciar cada parte em uma nova páginaAtivado por padrão
Folha de rosto para cada parteO título da parte e sua linha em uma página própria
Exportar cada parte deAtual, ou uma das linhas de base do documento da parte. Uma parte fixada mostra 📌 e o nome da linha de base na sua linha, e exporta o conteúdo dessa linha de base.

Ferramentas de IA

✦ IA ▾ na barra superior lista as ferramentas de IA para a seleção e para o documento. Todo resultado de IA é pré-visualizado primeiro, e um único Desfazer reverte tudo. Em uma linha de base, as ferramentas ficam desativadas. Veja IA.

  • Para um Requirement ou Statement selecionado: Reescrever com clareza…, Adicionar critérios mensuráveis… (requisitos), Simplificar…, Dividir requisito composto…, Redigir justificativa…, Sugerir nome…, Checar com IA (este requisito)…, Gerar requisitos filhos… e Gerar caso de teste… (requisitos).
  • Para qualquer item selecionado: Gerar riscos….
  • Para o documento: Gerar requisitos…, Resumir documento…, Traduzir documento… e Checar com IA (N requisitos)….

Atalhos de teclado

TeclasAção
⌘F / Ctrl+FLocalizar no documento
Enter / Shift+EnterPróxima / anterior correspondência (na caixa de pesquisa)
⌘↵ / Ctrl↵Adicionar um item após o selecionado
⌥⌘↵ / Ctrl+Alt↵Adicionar um filho do item selecionado
⌥⇧→ / Alt+Shift+→ / ⌥⇧← / Alt+Shift+←Recuar / avançar o item selecionado
⌥ / Alt+↑ / ⌥ / Alt+↓Mover o item selecionado para cima / para baixo
↑ / ↓Selecionar a linha anterior / seguinte; o foco acompanha
TabPróximo campo: a linha selecionada, depois o número, o nome e a descrição dela
Enter / F2Em uma linha, editar o nome; em um número, nome ou descrição, editá-lo
Delete ou BackspaceRemover os itens selecionados do documento (Desfazer na mensagem)
⇧Delete / Shift+DeleteExcluir os itens selecionados e seus filhos, após uma confirmação
EscDesmarcar; na caixa de pesquisa, limpar a pesquisa
Enter / EscSalvar / cancelar a edição de um número ou nome (o foco fica no campo)
↑ ↓ Home End na estruturaPercorrer os itens da estrutura
→ / ← na estruturaExpandir / recolher um item, ou ir ao primeiro filho / ao pai dele
Enter / Space na estruturaAbrir o item no documento (o foco vai para a linha dele) / selecioná-lo
⌘Z / Ctrl+Z / ⇧⌘Z / Ctrl+Shift+ZDesfazer / refazer (fora de um editor)

No Windows e no Linux, use Ctrl no lugar de ⌘ / Ctrl e Alt no lugar de ⌥ / Alt. Os atalhos de linha funcionam quando nenhum campo tem o foco. ⌘↵ / Ctrl↵ e ⌥⌘↵ / Ctrl+Alt↵ também funcionam durante a edição de um número ou nome. Veja Atalhos de teclado e as teclas de texto formatado acima.

Ajustes lembrados neste navegador

Guardado neste navegador:

  • Se o painel de estrutura está oculto, e a largura dele.
  • As colunas e as larguras das colunas por documento.
  • A ordenação da lista.
  • A classe atual para novos itens.
  • O último tipo de relatório.
  • Os modelos salvos antes da versão 1.8.0, até que você os importe para um projeto.

Salvo com o documento e compartilhado com todos no projeto: Papel, Status de rastreamento, o modelo Word, a numeração do documento, o padrão de numeração e o primeiro número, e a renumeração automática. Os modelos Word do projeto são salvos com o projeto.

Mensagens

MensagemSignificado e correção
Nenhum documento / "Crie um documento com + Novo documento, ou importe Word, Excel, CSV ou ReqIF com Importar."O projeto ainda não tem documentos.
"Nenhum documento corresponde. Limpe a pesquisa ou escolha Todos."Limpe Pesquisar documentos… ou clique em Todos.
Documento não encontradoO endereço aponta para um documento excluído. Use Voltar aos documentos.
Este documento está vazio / "Adicione um requisito com “+ Novo requisito”, ou preencha o documento a partir de um modelo com Escrever → Aplicar modelo…."Adicione itens ou aplique um modelo.
"Nenhum item corresponde ao filtro. Limpe o filtro para ver todos os itens."Altere ou limpe os chips de classe e de rótulo.
Visão filtrada: edição desativada. Limpar filtro / "Limpe o filtro ou a ordenação para adicionar entidades"A edição está pausada; clique no aviso para limpar.
"Digite o texto primeiro."A adição rápida foi enviada vazia.
"A entidade selecionada não pode ir mais longe nessa direção."O item é o primeiro ou o último, está bloqueado ou está ao lado de um item bloqueado.
"Uma entidade não pode ficar sob o próprio filho. Escolha outro pai."Escolha um destino fora da subárvore do item.
Desatualizado (coluna Pontuação de qualidade)O texto mudou após a última checagem de qualidade. Execute-a novamente.
"Não foi possível carregar os modelos de documento."O catálogo de modelos não carregou; recarregue a página.
"A pré-visualização mostra apenas exportações em planilha. Escolha uma exportação Excel."A pré-visualização funciona apenas para relatórios Excel.
"Este documento não tem linha de base. Salve uma primeiro."Crie uma linha de base antes de gerar relatórios de alterações.
"Falha na exportação: … Verifique o modelo Word e exporte novamente."Uma exportação Word com um clique falhou; verifique o modelo em Editar modelos Word….
"A imagem excede o limite de N MB." / "O arquivo excede o limite de N MB."O arquivo é maior que o limite por arquivo do servidor.

Limites

Limite: Os nomes editados em uma linha do documento são limitados a 200 caracteres, e os números a 139. A adição rápida aceita 2.000 caracteres.

Limite: As imagens são reduzidas a 4.000 px no lado maior. Arquivos anexados e imagens são limitados pelo limite por arquivo do servidor (10 MB no plano Free, 25 MB no Individual, 100 MB no Team) e pela cota de armazenamento do projeto.

Limite: A saída Word incorpora apenas imagens PNG, JPEG e GIF. Níveis de título mais profundos que 6 são mostrados como Título 6.

Limite: Os modelos da organização existem nos servidores do Holarch (hospedados ou auto-hospedados), não no app desktop; o app desktop guarda os modelos do projeto no arquivo do projeto. Uma organização guarda até 200 modelos de até 3.000 seções cada. Os modelos salvos em um projeto não são oferecidos em outros projetos: salve o modelo na organização, ou salve-o novamente no outro projeto.