Holarch
Capítulos do curso

Treinamento · Trilha 1. Primeiros passos · Capítulo 1.5 de 8

1.5 Documentos 2:46

Escreva uma especificação cujos requisitos são itens do modelo.

Mostra o Holarch 1.27.

← 1.4 Seu primeiro diagrama · Todos os capítulos · 1.6 Encontrar o que procura →

O que você vai aprender

  • Criar uma especificação de requisitos a partir de um modelo integrado
  • Adicionar um requisito sob uma seção e escrever sua declaração com shall
  • Adicionar vários requisitos rapidamente com Adição rápida
  • Encontrar os requisitos de um documento no Banco de dados como itens do modelo
  • Exportar a especificação para o Word pelo menu Entregar

Crie a especificação de requisitos do sistema da Bike-Share Dock a partir de um modelo integrado, escreva um requisito sob uma seção com + Filho e o inspetor, adicione mais com Adição rápida, veja que cada requisito do documento é um item do modelo no Banco de dados e exporte o documento para o Word.

Arquivos de projeto

  • Projeto inicial (.holarch.json; Gerenciar projetos → Arquivos de projeto ▾ → Importar projeto (.json)…)
  • Projeto concluído (.holarch.json; Gerenciar projetos → Arquivos de projeto ▾ → Importar projeto (.json)…)

O vídeo é reproduzido a partir de holarch.app; veja a Política de Privacidade.

Prática

Faça isto você mesmo no Holarch, no projeto de demonstração CubeSat EO-1.

  1. Abra seu projeto de demonstração EO-1 (ou crie-o: Gerenciar projetos → Arquivos de projeto ▾ → Novo projeto de demonstração → CubeSat (engenharia de sistemas guiada)).
  2. Abra Necessidades e requisitos → Documentos e clique em + Novo documento. Dê a ele o nome EO-1 Ground Station Specification, escolha o modelo Especificação de requisitos e clique em Criar.
  3. Selecione a seção 4.1 Primary Functions, clique em + Filho, dê ao requisito o nome Track the Spacecraft e escreva sua declaração com shall na descrição do inspetor.
  4. Em Adição rápida, na parte inferior, escolha Sob 10 Design Constraints, digite The ground station antenna shall have a diameter of no more than 3.7 m. e pressione Enter. Adicione uma segunda restrição da mesma forma.
  5. Abra o Banco de dados e digite in:"EO-1 Ground Station Specification" class:Requirement na caixa de busca para listar os novos requisitos.
  6. De volta ao documento, escolha Entregar ▾ → Especificação (Word) e abra o arquivo.

Você terminou quando o arquivo Word mostrar seus três requisitos sob as respectivas seções numeradas.

Teste-se

  1. Qual é a diferença entre um requisito digitado em um documento do Holarch e um digitado em um processador de texto?
  2. Como a Adição rápida escolhe o nome do novo requisito?
  3. Quando você marcaria Incluir orientações de redação?
Mostrar as respostas
  1. Qual é a diferença entre um requisito digitado em um documento do Holarch e um digitado em um processador de texto?

    No Holarch, cada requisito do documento é um item do modelo: você pode rastreá-lo, checar sua qualidade, desenhá-lo em diagramas e encontrá-lo no Banco de dados.

  2. Como a Adição rápida escolhe o nome do novo requisito?

    Ela dá nome ao requisito a partir das palavras depois de shall e o numera depois dos irmãos dele na seção escolhida.

  3. Quando você marcaria Incluir orientações de redação?

    Quando os autores são novos no tipo de documento: cada seção recebe então uma breve nota sobre o que deve conter, que você apaga enquanto escreve.

Saiba mais

Transcrição

Mostrar a transcrição (narração e o que aparece na tela)

Introduction

Chapter five: documents. Requirements usually live in a specification. In Holarch a document is an outline of model items, so every requirement in it is an item you can trace, check and draw.

We continue with the Bike-Share Dock project, and write its system requirements specification.

Create from a template

Open Needs and Requirements, then Documents, and click New Document.

On screen: Needs & Requirements → Documents → + New Document.

Name it Bike-Share Dock System Requirements. The templates below are for requirements documents; the menu next to them shows the templates for other kinds of document.

On screen: New Document: name; templates for Requirements Document.

A template gives the document its sections. Include writing guidance adds notes that explain what each section should hold. Choose Requirements Specification, with the sections only, and click Create.

On screen: Template: Requirements Specification → Create.

The document opens with the template's numbered sections, from document control to the appendices. The outline on the left lists them, and clicking an entry jumps to it.

On screen: The new document and its outline.

Write requirements

Select section 4.1, Primary Functions. Open the menu next to After, and choose Add Child. A new requirement appears under the section, numbered 4.1.1, with its name ready to type. Type Show Available Bikes, and press Enter.

On screen: 4.1 → + After ▾ → Add Child → Show Available Bikes.

Then write the shall statement. Click the description in the inspector, type it, and click elsewhere to save.

On screen: Inspector → Description.

To add many requirements quickly, use Quick add at the bottom of the document. Choose the section Design Constraints, type the requirement, and click Add, or press Enter.

On screen: Quick add → Under 10. Design Constraints → Add.

Holarch adds it under the section, and names it from the words after shall. The cursor stays in the field, so the next requirement is one more line.

On screen: Second Quick add.

One model

Each requirement in the document is a model item. Open the Database and filter to requirements: the new ones are listed with the requirements from chapter two.

On screen: Database → + Filter → Requirement.

Export

Back in the document, the Deliver menu makes the Word file: the specification with a table of contents and the numbered requirements, ready to send for review. Choose Specification (Word).

On screen: Back to the document → Deliver ▾ → Specification (Word).

Recap

Let's recap. You created a specification from a template, wrote a requirement under a section, added more with Quick add, saw that they are model items, and exported the document to Word.

Next, you learn the quickest ways to find anything in a growing model.