Holarch
과정의 장

교육 · 트랙 1. 시작하기 · 1.5장 (전체 8장)

1.5 문서 2:46

요구사항이 모델 항목인 명세서를 작성합니다.

Holarch 1.27 화면입니다.

학습 내용

  • 기본 제공 템플릿으로 요구사항 명세서 만들기
  • 섹션 아래에 요구사항을 추가하고 shall 문장 작성하기
  • 빠른 추가로 여러 요구사항을 빠르게 추가하기
  • 데이터베이스에서 문서의 요구사항을 모델 항목으로 찾기
  • 납품 메뉴에서 명세서를 Word로 내보내기

기본 제공 템플릿으로 Bike-Share Dock의 시스템 요구사항 명세서를 만들고, + 하위와 속성 패널로 섹션 아래에 요구사항을 작성하고, 빠른 추가로 더 추가하고, 문서의 모든 요구사항이 데이터베이스의 모델 항목임을 확인하고, 문서를 Word로 내보냅니다.

프로젝트 파일

  • 시작 프로젝트 (.holarch.json; 프로젝트 관리 → 프로젝트 파일 ▾ → 프로젝트 가져오기 (.json)…)
  • 완성 프로젝트 (.holarch.json; 프로젝트 관리 → 프로젝트 파일 ▾ → 프로젝트 가져오기 (.json)…)

동영상은 holarch.app에서 재생됩니다. 개인정보 처리방침을 참조하십시오.

실습

CubeSat EO-1 데모 프로젝트에서 Holarch로 직접 해 보십시오.

  1. EO-1 데모 프로젝트를 여십시오(또는 만드십시오: 프로젝트 관리 → 프로젝트 파일 ▾ → 새 데모 프로젝트 → CubeSat (Guided systems engineering)).
  2. 니즈 및 요구사항 → 문서를 열고 + 새 문서를 클릭합니다. 이름을 EO-1 Ground Station Specification으로 지정하고, 템플릿 Requirements Specification을 선택한 다음 만들기를 클릭합니다.
  3. 섹션 4.1 Primary Functions를 선택하고 + 하위를 클릭한 다음, 요구사항 이름을 Track the Spacecraft로 지정하고 속성 패널의 설명에 shall 문장을 작성합니다.
  4. 아래쪽의 빠른 추가에서 10 Design Constraints 아래를 선택하고 The ground station antenna shall have a diameter of no more than 3.7 m.를 입력한 다음 Enter 키를 누릅니다. 같은 방법으로 두 번째 제약 조건을 추가합니다.
  5. 데이터베이스를 열고 검색 상자에 in:"EO-1 Ground Station Specification" class:Requirement를 입력하여 새 요구사항을 나열합니다.
  6. 문서로 돌아가 납품 ▾ → 사양 (Word)을 선택하고 파일을 엽니다.

Word 파일에 번호가 매겨진 섹션 아래에 세 요구사항이 표시되면 완료입니다.

스스로 확인

  1. Holarch 문서에 입력한 요구사항과 워드프로세서에 입력한 요구사항의 차이는 무엇입니까?
  2. 빠른 추가는 새 요구사항의 이름을 어떻게 정합니까?
  3. 작성 지침 포함은 언제 선택합니까?
답 보기
  1. Holarch 문서에 입력한 요구사항과 워드프로세서에 입력한 요구사항의 차이는 무엇입니까?

    Holarch에서는 문서의 각 요구사항이 모델 항목입니다. 추적하고, 품질을 검사하고, 다이어그램에 그리고, 데이터베이스에서 찾을 수 있습니다.

  2. 빠른 추가는 새 요구사항의 이름을 어떻게 정합니까?

    shall 뒤의 단어로 요구사항의 이름을 짓고, 선택한 섹션의 형제 항목 다음 번호를 매깁니다.

  3. 작성 지침 포함은 언제 선택합니까?

    작성자가 그 문서 유형에 익숙하지 않을 때입니다. 그러면 각 섹션에 담아야 할 내용에 대한 짧은 메모가 들어가며, 작성하면서 삭제합니다.

더 읽어 보기

대본

대본 보기 (내레이션과 화면 내용)

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.