Capítulos del curso
Formación · Curso 4. Documentos y entregables · Capítulo 4.1 de 5
4.1 Plantillas de documento 2:54
Empezar un plan o una especificación a partir de una plantilla, con pautas para cada sección.
Muestra Holarch 2.13.
Lo que aprenderá
- Crear un documento del tipo elegido a partir de una plantilla integrada
- Incluir pautas de redacción y leer las pautas de una sección
- Sustituir las pautas de una sección por texto propio y guardarlo
- Explicar por qué cada sección del documento es un elemento del modelo
Cree el plan de gestión de ingeniería de sistemas del Bike-Share Dock a partir de una plantilla integrada: elija el tipo de documento, compare el esquema con la plantilla guiada, lea las pautas de cada sección, sustitúyalas por su propio texto y compruebe que cada sección es un elemento del modelo.
Archivos de proyecto
- Proyecto inicial (.holarch.json; Gestionar proyectos → Archivos de proyecto ▾ → Importar proyecto (.json)…)
- Proyecto terminado (.holarch.json; Gestionar proyectos → Archivos de proyecto ▾ → Importar proyecto (.json)…)
El vídeo se reproduce desde holarch.app; consulte la Política de privacidad.
Práctica
Hágalo usted mismo en Holarch, en el proyecto de demostración CubeSat EO-1.
- Abra su proyecto de demostración EO-1 o créelo: Gestionar proyectos → Archivos de proyecto ▾ → Nuevo proyecto de demostración → CubeSat (ingeniería de sistemas guiada).
- Abra Necesidades y requisitos → Documentos y haga clic en + Nuevo documento. Llámelo
EO-1 Interface Control Document. - En Plantillas para, elija Interface Control Document, marque Incluir pautas de redacción, elija la tarjeta Interface Control Document (ICD) y haga clic en Crear.
- Seleccione la sección 2.3 Interface Owners and Change Authority y lea sus pautas. Haga clic en su descripción, sustituya las pautas por los responsables de las interfaces de EO-1 (por ejemplo, el Payload Lead y el Comms Lead) y pulse ⌘ / Ctrl↵ para guardar.
- Seleccione la sección 3.2 Interface Matrix y lea la matriz de interfaces dinámica que la plantilla colocó allí.
- Para un recorrido guiado y comprobado, ejecute el tutorial 11 Produce the Deliverable (Ayuda → Tutoriales).
Habrá terminado cuando el nuevo ICD muestre su propio texto en 2.3 en lugar de las pautas, y 3.2 muestre una matriz de componentes de EO-1.
Compruebe lo aprendido
- ¿Qué determina las plantillas que Nuevo documento ofrece primero?
- ¿Qué diferencia hay entre una plantilla con pautas de redacción y una sin ellas?
- ¿Por qué importa que cada sección sea un elemento del modelo?
Mostrar las respuestas
¿Qué determina las plantillas que Nuevo documento ofrece primero?
El tipo de documento elegido en Plantillas para. Las plantillas de otros tipos siguen apareciendo en Otras plantillas; el documento recibe el tipo de la plantilla que elija.
¿Qué diferencia hay entre una plantilla con pautas de redacción y una sin ellas?
Ambas ofrecen las mismas secciones numeradas y tablas iniciales. Con pautas, cada sección empieza además con una breve guía de lo que debe contener, que se sustituye a medida que se redacta.
¿Por qué importa que cada sección sea un elemento del modelo?
Una sección es un Statement, de modo que se puede vincular, comentar e incluir en una línea base como un requisito, y el documento sigue siendo una vista del modelo.
Más información
Transcripción
Mostrar la transcripción (narración y lo que aparece en pantalla)
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.