Capítulos do curso
Treinamento · Trilha 4. Documentos e entregáveis · Capítulo 4.1 de 5
4.1 Modelos de documento 2:54
Comece um plano ou uma especificação a partir de um modelo, com orientações para cada seção.
Mostra o Holarch 2.13.
O que você vai aprender
- Criar um documento de um tipo escolhido a partir de um modelo integrado
- Incluir orientações de redação e ler as orientações em uma seção
- Substituir as orientações de uma seção pelo seu próprio texto e salvá-lo
- Explicar por que cada seção do documento é um item do modelo
Crie o plano de gerenciamento de engenharia de sistemas da Bike-Share Dock a partir de um modelo integrado: escolha o tipo de documento, compare o esboço e o modelo com orientações, leia as orientações de cada seção, substitua-as pelo seu próprio texto e veja que cada seção é um item do modelo.
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.
- 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).
- Abra Necessidades e requisitos → Documentos e clique em + Novo documento. Dê a ele o nome
EO-1 Interface Control Document. - Em Modelos para, escolha Documento de controle de interfaces, marque Incluir orientações de redação, escolha o cartão Documento de controle de interfaces (ICD) e clique em Criar.
- Selecione a seção 2.3 Interface Owners and Change Authority e leia suas orientações. Clique na descrição, substitua as orientações pelos responsáveis pelas interfaces do EO-1 (por exemplo, o Payload Lead e o Comms Lead) e pressione ⌘ / Ctrl↵ para salvar.
- Selecione a seção 3.2 Interface Matrix e leia a matriz de interfaces ao vivo que o modelo colocou ali.
- Para um passo a passo checado, execute o tutorial 11 Produce the Deliverable (Ajuda → Tutoriais).
Você terminou quando o novo ICD mostrar seu próprio texto em 2.3 no lugar das orientações, e 3.2 mostrar uma matriz dos componentes do EO-1.
Teste-se
- O que decide quais modelos Novo documento oferece primeiro?
- Qual é a diferença entre um modelo com e sem orientações de redação?
- Por que importa que cada seção seja um item do modelo?
Mostrar as respostas
O que decide quais modelos Novo documento oferece primeiro?
O tipo de documento escolhido em Modelos para. Os modelos de outros tipos continuam listados em Outros modelos; o documento recebe o tipo do modelo que você escolher.
Qual é a diferença entre um modelo com e sem orientações de redação?
Ambos dão as mesmas seções numeradas e tabelas iniciais. Com orientações, cada seção também começa com um breve guia do que deve conter, que você substitui enquanto escreve.
Por que importa que cada seção seja um item do modelo?
Uma seção é um Statement, então você pode vinculá-la, comentá-la e colocá-la em uma linha de base como um requisito, e o documento continua sendo uma visão do modelo.
Saiba mais
Transcrição
Mostrar a transcrição (narração e o que aparece na tela)
Introduction
Welcome to track four: documents and deliverables. Programs are reviewed through their documents: plans, specifications, and the matrices reviewers ask for. In Holarch, these are built from the model. This first chapter covers document templates.
You will pick a document type and its template, compare an outline with a template that has guidance, and write your own text over that guidance.
Choose a type
We continue with the Bike-Share Dock. It already has requirements, functions, parts and test cases. Open Needs and Requirements, then Documents, and click New Document.
On screen: Needs & Requirements → Documents → + New Document.
The type decides which templates are offered. Holarch has templates for the documents most programs write, from the concept of operations to the test plan, and for the concept stage: needs analysis, concept exploration and concept definition.
On screen: Card: document types with templates.
Name it Bike-Share Dock SEMP. Then, under Templates for, choose Systems Engineering Management Plan Document.
On screen: Name, then Templates for ▾ → Systems Engineering Management Plan Document.
Outline or guidelines
Each template comes in two forms. The outline has only the section headings. With writing guidance, every section also explains what it should hold, with an example. Tick Include writing guidance, choose the template, and click Create.
On screen: Include writing guidance → the template card → Create.
The plan opens with fifteen numbered sections: the life cycle, the technical reviews, requirements management, baselines, interfaces, verification, risk, and the tools and model.
On screen: The new plan and its outline.
Write your plan
Click section 2.1, Purpose. Its text is the guidance: state why this plan exists and who uses it, followed by an example.
On screen: Outline → 2.1 Purpose.
Replace the guidance with your own text. Click the description to edit it, select its text, and type the purpose of this plan. Then press Command Return to save it.
On screen: Edit 2.1's description → type → Save.
The guidance often points to where the work lives in Holarch. Section 8.1, Baselines, says to use Holarch baselines, so that later changes can be compared against them. Chapter four of this track shows how.
On screen: Outline → 8.1 Baselines.
Every section is a model item, a statement, so you can link it, comment on it and baseline it, like a requirement.
On screen: 8.1's class badge: Statement.
Recap
Let's recap. You chose a document type and its template, picked the template with guidelines, read the guidance in a section, and replaced it with your own text.
Next, you put live traceability and verification matrices into a document.