Главы курса
Обучение · Курс 4. Документы и результаты работ · Глава 4.1 из 5
4.1 Шаблоны документов 2:54
Начните план или спецификацию с шаблона, с рекомендациями для каждого раздела.
Показан Holarch 2.13.
Чему вы научитесь
- Создавать документ выбранного типа из встроенного шаблона
- Включать рекомендации по написанию и читать рекомендации в разделе
- Заменять рекомендации раздела собственным текстом и сохранять его
- Объяснять, почему каждый раздел документа — элемент модели
Создайте план управления системной инженерией для станции Bike-Share Dock из встроенного шаблона: выберите тип документа, сравните структуру и шаблон с рекомендациями, прочитайте рекомендации в каждом разделе, замените их собственным текстом и убедитесь, что каждый раздел — элемент модели.
Файлы проектов
- Начальный проект (.holarch.json; Управление проектами → Файлы проекта ▾ → Импортировать проект (.json)…)
- Готовый проект (.holarch.json; Управление проектами → Файлы проекта ▾ → Импортировать проект (.json)…)
Видео воспроизводится с holarch.app; см. Политику конфиденциальности.
Практика
Выполните это сами в Holarch на демо-проекте CubeSat EO-1.
- Откройте свой демо-проект EO-1 или создайте его: Управление проектами → Файлы проекта ▾ → Новый демо-проект → CubeSat (пошаговая системная инженерия).
- Откройте Потребности и требования → Документы и нажмите + Новый документ. Назовите его
EO-1 Interface Control Document. - В разделе Шаблоны для выберите Документ управления интерфейсом, установите флажок Включить рекомендации по написанию, выберите карточку Документ управления интерфейсом (ICD) и нажмите Создать.
- Выберите раздел 2.3 Interface Owners and Change Authority и прочитайте его рекомендации. Щёлкните его описание, замените рекомендации владельцами интерфейсов EO-1 (например, Payload Lead и Comms Lead) и нажмите ⌘ / Ctrl↵, чтобы сохранить.
- Выберите раздел 3.2 Interface Matrix и прочитайте живую матрицу интерфейсов, которую туда поместил шаблон.
- Для пошагового прохождения с проверкой запустите учебный материал 11 «Produce the Deliverable» (Справка → Учебные материалы).
Готово, когда новый ICD показывает в 2.3 ваш собственный текст вместо рекомендаций, а в 3.2 — матрицу компонентов EO-1.
Проверьте себя
- От чего зависит, какие шаблоны «Новый документ» предлагает первыми?
- Чем шаблон с рекомендациями по написанию отличается от шаблона без них?
- Почему важно, что каждый раздел — элемент модели?
Показать ответы
От чего зависит, какие шаблоны «Новый документ» предлагает первыми?
От типа документа, выбранного в «Шаблоны для». Шаблоны других типов по-прежнему перечислены в разделе «Другие шаблоны»; документ получает тип выбранного шаблона.
Чем шаблон с рекомендациями по написанию отличается от шаблона без них?
Оба дают одинаковые нумерованные разделы и начальные таблицы. С рекомендациями каждый раздел также начинается с краткого описания того, что в нём должно быть, и вы заменяете его по мере написания.
Почему важно, что каждый раздел — элемент модели?
Раздел — это Statement, поэтому его можно связывать, комментировать и включать в базовую линию, как требование, а документ остаётся представлением модели.
Подробнее
Расшифровка
Показать расшифровку (дикторский текст и то, что на экране)
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.