Розділи курсів
Навчання · Курс 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.