과정의 장
교육 · 트랙 4. 문서와 산출물 · 4.1장 (전체 5장)
4.1 문서 템플릿 2:54
모든 섹션에 대한 안내가 있는 템플릿에서 계획서나 명세서를 시작합니다.
Holarch 2.13 화면입니다.
학습 내용
- 기본 제공 템플릿에서 선택한 유형의 문서 만들기
- 작성 지침을 포함하고 섹션의 지침 읽기
- 섹션의 지침을 직접 작성한 텍스트로 바꾸고 저장하기
- 각 문서 섹션이 모델 항목인 이유 설명하기
기본 제공 템플릿에서 Bike-Share Dock의 시스템 엔지니어링 관리 계획서를 만듭니다. 문서 유형을 선택하고, 개요와 지침 포함 템플릿을 비교하고, 각 섹션의 지침을 읽고, 직접 작성한 텍스트로 바꾸고, 모든 섹션이 모델 항목임을 확인합니다.
실습
CubeSat EO-1 데모 프로젝트에서 Holarch로 직접 해 보십시오.
- EO-1 데모 프로젝트를 열거나 만드십시오. 프로젝트 관리 → 프로젝트 파일 ▾ → 새 데모 프로젝트 → CubeSat (Guided systems engineering).
- 니즈 및 요구사항 → 문서를 열고 + 새 문서를 클릭합니다. 이름을
EO-1 Interface Control Document로 지정합니다. - 템플릿 대상에서 Interface Control Document를 선택하고, 작성 지침 포함을 선택한 다음, 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.