Capítulos del curso
Formación · Curso 1. Primeros pasos · Capítulo 1.5 de 8
1.5 Documentos 2:46
Redactar una especificación cuyos requisitos son elementos del modelo.
Muestra Holarch 1.27.
Lo que aprenderá
- Crear una especificación de requisitos a partir de una plantilla integrada
- Añadir un requisito bajo una sección y redactar su enunciado con «shall»
- Añadir varios requisitos rápidamente con Añadido rápido
- Encontrar los requisitos de un documento en la Base de datos como elementos del modelo
- Exportar la especificación a Word desde el menú Entregar
Cree la especificación de requisitos del sistema del Bike-Share Dock a partir de una plantilla integrada, redacte un requisito bajo una sección con + Hijo y el inspector, añada más con Añadido rápido, compruebe que cada requisito del documento es un elemento del modelo en la Base de datos y exporte el documento a Word.
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 Ground Station Specification, elija la plantilla Requirements Specification y haga clic en Crear. - Seleccione la sección 4.1 Primary Functions, haga clic en + Hijo, llame al requisito
Track the Spacecrafty escriba su enunciado con «shall» en la descripción del inspector. - En Añadido rápido, abajo, elija Debajo de 10 Design Constraints, escriba
The ground station antenna shall have a diameter of no more than 3.7 m.y pulse Intro. Añada una segunda restricción del mismo modo. - Abra la Base de datos y escriba
in:"EO-1 Ground Station Specification" class:Requirementen el cuadro de búsqueda para listar los nuevos requisitos. - De vuelta en el documento, elija Entregar ▾ → Especificación (Word) y abra el archivo.
Habrá terminado cuando el archivo Word muestre sus tres requisitos bajo sus secciones numeradas.
Compruebe lo aprendido
- ¿Qué diferencia hay entre un requisito escrito en un documento de Holarch y uno escrito en un procesador de textos?
- ¿Cómo elige Añadido rápido el nombre del nuevo requisito?
- ¿Cuándo conviene marcar Incluir pautas de redacción?
Mostrar las respuestas
¿Qué diferencia hay entre un requisito escrito en un documento de Holarch y uno escrito en un procesador de textos?
En Holarch, cada requisito del documento es un elemento del modelo: se puede trazar, comprobar su calidad, dibujarlo en diagramas y encontrarlo en la Base de datos.
¿Cómo elige Añadido rápido el nombre del nuevo requisito?
Nombra el requisito con las palabras que siguen a «shall» y lo numera a continuación de sus hermanos en la sección elegida.
¿Cuándo conviene marcar Incluir pautas de redacción?
Cuando los autores son nuevos en ese tipo de documento: cada sección recibe entonces una breve nota sobre lo que debe contener, que se borra a medida que se redacta.
Más información
Transcripción
Mostrar la transcripción (narración y lo que aparece en pantalla)
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.