요구사항
문서 생성
실시간 추적성, 검증, 인터페이스 매트릭스와 테스트 보고서를 문서에 넣고, 네 가지 형식으로 내보내고, 베이스라인에서 생성하고, 표시를 붙입니다. 회사 고지, DoD 배포 문구, 수출 통제 고지, 저작권 또는 계약 번호를 모든 페이지와 내보내기에 넣을 수 있습니다.
이 페이지의 내용
개요
Holarch는 모델에서 납품물을 만들므로, 문서는 항상 그 뒤에 있는 요구사항, 테스트, 연결과 일치합니다. 세 가지 도구가 검토자가 보통 요구하는 것을 다룹니다.
- 매트릭스 블록: 문서 텍스트 안의 추적성, 검증 또는 인터페이스 매트릭스나 테스트 보고서로, 모델이 바뀔 때마다 업데이트됩니다.
- 매트릭스 내보내기: 같은 매트릭스와 테스트 보고서를 현재 모델이나 베이스라인에서 Excel, Word, CSV 또는 웹 페이지의 별도 파일로.
- 표시와 페이지 설정: 조직, 프로젝트 또는 문서 하나에 대한 표시(회사 고지, 배포 진술, 수출 통제 고지, 저작권 또는 계약 번호)를 모든 내보내기에, 그리고 Word용 표지와 페이지 번호.
텍스트 안의 라이브 값과 표는 문서 페이지에서 다룹니다. Live Value…는 엔터티의 속성 하나를, 개수 또는 합계…는 쿼리로 계산한 숫자를, Live Table…은 쿼리로 만든 표를, 상호 참조…는 섹션, 그림 또는 표의 현재 번호를 삽입합니다.
개념
매트릭스
| 매트릭스 | 행 | 열 | 공백으로 강조 표시되는 것 |
|---|---|---|---|
| RTM(Requirements Traceability Matrix) | 요구사항 | Number, Requirement, Parent, Traced From, Traced To, Satisfied By | 상위 항목도 없고 traced from 대상도 없는 요구사항 |
| 요구사항 하향 전개 매트릭스 | 요구사항 | Number, Requirement, Flows Down From, Flows Down To, Derived Requirements | 하위 항목도 파생 요구사항도 없는 최상위 요구사항 |
| 요구사항 할당 매트릭스 | 요구사항 | Number, Requirement, Components, Functions, Other | 아무것도 충족하지 않는 요구사항 |
| 준수 매트릭스(공식 프로그램이 켜져 있을 때 표시) | 고객 사양서의 요구사항 | Number, Requirement, Compliance, Response, Our Requirements and Design, Verification, Deviation/Waiver | 준수 진술이 없는 요구사항(평가되지 않음) |
| RVTM(Requirements Verification Traceability Matrix) | 요구사항 | Number, Requirement, Method, Level, Verified By, Status | 검증 방법이 없거나 검증하는 테스트 케이스가 없음 |
| VCRM(Verification Cross-Reference Matrix) | 요구사항 | Number, Requirement, Inspection, Analysis, Demonstration, Test, Verified By, Status | 선택한 검증 방법 없음 |
| 검증 수준별 VCRM | 요구사항 | Number, Requirement, 그다음 각 검증 수준 아래의 I, A, D, T, Verified By, Status | 검증 방법이 없거나 검증 수준이 없음 |
| 테스트 보고서 | 테스트 주기의 테스트 케이스 | Number, Test Case, Verifies, Status, Actual Result, Run | 주기에서 통과하지 못한 테스트 케이스 |
| 할당 매트릭스 | 기능(Action) | Number, Function, Performed By | 어떤 구성 요소도 수행하지 않는 기능 |
| 인터페이스 매트릭스 | 구성 요소(Asset) | 같은 구성 요소. 셀에는 행 구성 요소에서 열 구성 요소로 가는 Conduit이 나열됩니다 | 다른 구성 요소와 주고받는 Conduit이 없는 구성 요소 |
| N² 매트릭스 | 기능(Action) | 같은 기능. 셀에는 행 기능이 생성하고 열 기능이 받는 Input/Output이 나열됩니다 | 입력이나 출력을 주고받지 않는 기능 |
| 사용자 지정 매트릭스 | 검색 쿼리로 얻은 엔터티 | 두 번째 쿼리로 얻은 엔터티. 셀에는 둘 사이의 관계 이름이, 또는 선택한 관계 하나에 대해 X가 표시됩니다 | 어떤 열과도 관계가 없는 행 |
- Parent는 행이 decomposes하는 요구사항입니다. Traced From, Traced To, Satisfied By는 관련 엔터티를 나열합니다. 하향 전개 매트릭스에서 Derived Requirements는 행이 traces to하는 요구사항입니다.
- VCRM에서 X는 계획된 각 방법을 표시합니다. 상태는 지금까지의 검증 결과로, 테스트 센터에서처럼 테스트 케이스에서 집계됩니다.
- 검증 수준별 VCRM에서는 열이 검증 수준 속성의 수준(Component, Subsystem, System)별로 묶입니다. X는 요구사항의 수준과 계획된 각 방법 아래에 놓입니다.
- 테스트 케이스는 기능으로 나열되지 않습니다. 할당 매트릭스와 N² 매트릭스는 Test Case가 아닌 Action을 보여 줍니다.
- 범위: 매트릭스는 문서 하나의 엔터티(문서 순서와 번호대로), 편집본의 모든 파트, 또는 프로젝트 전체를 다룹니다. 할당 매트릭스는 문서의 기능을, 문서에 기능이 없으면 모든 기능을 사용합니다. 인터페이스 매트릭스와 N² 매트릭스는 I² 및 N² 다이어그램처럼 Asset이나 Action 하나의 하위 항목도 다룰 수 있습니다. 프로젝트 전체에서는 Conduit이나 Input/Output이 있는 구성 요소나 기능을 최대 120개 나열합니다. 사용자 지정 매트릭스는 최대 2,000행과 120열을 보여 줍니다.
- 테스트 보고서 블록은 테스트 스위트 하나의 테스트 주기 하나, 또는 현재 결과를 보여 줍니다. 테스트 보고서를 참조합니다.
복사가 아닌 라이브
매트릭스 블록은 행이 아니라 무엇을 보여 줄지만 저장합니다. 문서를 표시하거나 내보낼 때마다 Holarch가 모델에서 행을 다시 만듭니다. 결과는 다음 변경까지 캐시되므로 큰 프로젝트도 빠르게 유지됩니다.
사용 방법
문서에 매트릭스 삽입
- 문서를 열고 문서나 항목의 설명을 클릭합니다.
- 서식 있는 텍스트 도구 모음에서 +를 열고 매트릭스…를 선택합니다.
- 매트릭스와 범위를 고릅니다. 범위는 열려 있는 문서로 시작합니다.
- 사용자 지정 매트릭스의 경우 행과 열 검색 쿼리(예:
class:Requirement와class:Asset)를 입력하고, 관계를 선택하거나 모든 관계를 그대로 두며, 원하면 제목을 붙입니다. - 테스트 보고서의 경우 테스트 스위트와 Test Cycle, 또는 현재 결과를 선택합니다.
미리 보기가 표시됩니다. 모델이 바뀔 때마다 업데이트됩니다.
- 사용자 지정 매트릭스의 경우 행과 열 검색 쿼리(예:
- 삽입을 클릭합니다.
매트릭스가 점선 윤곽과 함께 텍스트에 나타납니다. 캡션에 매트릭스, 범위, 공백이 있는 행 수가 표시됩니다.
매트릭스는 셀 단위로 편집할 수 없으므로 대신 모델을 바꿉니다. 제거하려면 편집기에서 다른 내용처럼 표를 삭제합니다.
매트릭스 내보내기
- 문서에서 납품 ▾를 열고 추적성 매트릭스…를 선택합니다. 또는 납품 ▾ → 모든 내보내기…를 선택하고 Traceability matrix (Excel), (Word), (CSV) 또는 (HTML)을 고릅니다.
- 매트릭스 내보내기에서 매트릭스와 범위를 고르고, 내보내기 형식에서 Matrix (Excel), Matrix (Word), Matrix (CSV) 또는 Matrix (HTML)을 선택합니다.
- 선택 사항: 모델에서 현재 모델 대신 베이스라인을 고릅니다. 목록에는 프로젝트의 베이스라인과 선택한 문서의 베이스라인이 표시됩니다.
필드 아래 줄에 행 수와 공백이 있는 행 수가 표시됩니다.
- 내보내기를 클릭합니다.
알림에 "매트릭스를 내보냈습니다."가 표시됩니다. Excel, Word, 웹 페이지에서 공백은 빨간색으로 음영 처리됩니다. Word와 웹 페이지 내보내기는 문서의 페이지 설정을 사용합니다. Word에서 텍스트 열은 넓고 검증 방법 열은 좁으며, 머리글은 I, A, D, T이고 표 아래에 범례(I = Inspection, A = Analysis, D = Demonstration, T = Test)가 있습니다. 열이 다섯 개를 넘는 매트릭스는 가로 방향 페이지를 사용합니다. 수준별 VCRM에는 수준이 있는 두 번째 머리글 행이 있으며, 인터페이스, N², 사용자 지정 매트릭스는 행 제목과 대각선을 음영 처리합니다.
베이스라인의 매트릭스
서명된 납품물은 현재 모델이 아니라 베이스라인 당시의 모델을 보여 주어야 합니다. 베이스라인에서 만든 매트릭스는 베이스라인의 엔터티와 관계를 사용하며, 제목이 "(baseline name)"으로 끝납니다.
- 매트릭스 내보내기: 모델에서 베이스라인을 선택합니다.
- 프로젝트 베이스라인은 모델 전체를 담으므로 모든 매트릭스가 그것으로 작동합니다.
- 문서 베이스라인은 문서, 그 항목, 그 항목에 연결된 엔터티를 담습니다. 그 문서의 매트릭스는 완전합니다. 문서 밖으로 미치는 매트릭스(프로젝트 전체, 또는 인터페이스나 N² 매트릭스)에는 "Built from a document baseline, which holds only that document and the entities linked to it." 메모가 붙습니다.
테스트 보고서
테스트 보고서는 테스트 주기 하나의 결과를 제공합니다. 무엇을 어떤 구성에서 시험했는지, 무엇이 통과하고 실패했는지, 그것이 어떤 요구사항을 검증하는지입니다.
- 테스트 센터에서 새 주기 시작…으로 테스트 주기를 기록합니다. 구성 / 빌드와 Test Article을 입력합니다(둘 다 실행에서 가장 자주 기록된 값으로 시작).
- 스위트 카드에서 ⋯를 열고 테스트 보고서…를 선택합니다. 또는 ⋯ → Test Cycles…를 열고 주기에서 보고서…를 클릭합니다.
- 테스트 보고서 내보내기에서 Test Cycle을 선택하고, 내보내기 형식에서 Test report (Word), (Excel), (CSV) 또는 (HTML)을 선택한 뒤 내보내기를 클릭합니다.
Word 보고서(기본값)에는 다음 섹션이 있습니다.
- Identification: 테스트 스위트, 테스트 주기, 결과가 저장된 시각, 보고서가 만들어진 시각.
- Test Environment and Configuration: 구성 또는 빌드, 시험 품목, 시험자, 실행 날짜.
- Summary of Results: 상태별 개수와 통과율.
- Results by Test Case: 테스트 케이스마다 한 행.
- Detailed Results: 테스트 케이스마다 기대 결과와 실제 결과, 시험자, 날짜, 구성, 시험 품목, 증거 파일, 단계 결과.
- Deviations and Open Issues: 실패하거나 차단된 테스트 케이스와 연결된 Issue.
- Test Evidence: 주기에 기록된 증거 파일.
- Requirement Verification Status: 스위트가 검증하는 요구사항과 이 주기 결과에 따른 상태.
Excel은 시트 세 개(Results, Steps, Requirements)를, CSV와 웹 페이지는 결과 표를 제공합니다. 결과는 저장된 주기에서 오므로 스위트를 초기화한 뒤에도 보고서는 같습니다. 이름, 검증된 요구사항, Issue는 현재 모델에서 옵니다. 단계 결과와 증거를 보관하기 전에 저장한 주기는 그 필드를 "—"로 표시합니다.
결과 표를 문서에 넣으려면 테스트 보고서 매트릭스 블록을 삽입합니다(위 참조).
문서와 내보내기에 표시
표시는 Holarch가 내보내는 모든 것에 인쇄하는 텍스트입니다. 모든 페이지 위쪽의 머리글, 모든 페이지 아래쪽의 바닥글, 첫 페이지의 고지입니다. 프로젝트나 조직에 대해 한 번 설정하면 모든 내보내기에 붙습니다. 문서는 자체 표시로 대신할 수 있습니다.
참고: 호스팅 서비스(app.holarch.app)는 CUI, 기밀 또는 수출 통제 정보를 담을 수 없습니다(이용 약관). 그래서 그곳의 표준 목록에는 Distribution Statement B~F와 수출 통제 고지가 빠져 있으며, CUI, 기밀 등급(SECRET//NOFORN 등), ITAR, EAR 또는 수출 통제, 또는 Distribution Statement B~F를 언급하는 표시는 저장되지 않습니다: "Holarch's hosted service can't hold CUI, classified or export-controlled information, so this marking can't be used here. Remove it, or use the desktop app or a self-hosted installation." Company Confidential, Distribution Statement A, 저작권, 계약 번호 같은 회사 고지는 계속 사용할 수 있습니다. 이 규칙 이전에 설정한 표시는 유지되고 계속 인쇄됩니다. 바꾸려면 제한된 부분을 제거합니다.
데스크톱 앱과 자체 호스팅 설치는 전체 목록을 제공하며 어떤 표시든 받습니다. 표시는 사용자가 고르는 텍스트입니다. Holarch는 그것을 인쇄할 뿐 취급 규칙을 강제하지 않으며, 조직 자체의 통제가 적용됩니다. 모든 에디션에서 표시에 수출 통제 고지가 있으면 프로젝트의 AI가 꺼집니다.
표준 표시 목록이 텍스트를 채워 줍니다.
| 표준 표시 | 헤더 | 바닥글 | 고지 |
|---|---|---|---|
| Company Proprietary | COMPANY PROPRIETARY | COMPANY PROPRIETARY | 회사를 명시하는 독점 정보 고지 |
| Company Confidential | COMPANY CONFIDENTIAL | COMPANY CONFIDENTIAL | 회사를 명시하는 기밀 유지 고지 |
| Distribution Statement A~F(B~F: 데스크톱 앱과 자체 호스팅 전용) | (없음) | DISTRIBUTION STATEMENT A to F | 해당 진술의 표준 DoD 문구(DoDI 5230.24)로, Reason, 결정일, 통제 부서가 채워집니다 |
| 수출 통제 고지(ITAR/EAR)(데스크톱 앱과 자체 호스팅 전용) | (없음) | Export-controlled technical data. See the notice on the first page. | 문서에 ITAR(22 CFR 120–130) 또는 EAR(15 CFR 730–774)에 해당하는 기술 데이터가 있을 수 있다는 경고 |
| Copyright | (없음) | © Year 저작권자. All rights reserved. | (없음) |
| Contract number | (없음) | Contract No. 계약 번호 | (없음) |
비워 둔 입력란은 [reason] 같은 대괄호 자리 표시자로 텍스트에 남습니다. 그러면 편집기에 "내보내기 전에 대괄호로 묶인 부분을 완성하십시오."가 표시됩니다.
프로젝트 표시 설정
- ⌘K / Ctrl+K를 누르고 프로젝트 표시…를 선택합니다. 문서의 페이지 설정…이나, 열려 있는 프로젝트의 프로젝트 환경설정…(홈의 홈 ▾)에서도 열 수 있습니다.
- 자체 표시를 선택합니다.
- 표준 표시에서 항목을 고르고, 그 필드(예: 회사)를 채운 뒤 표시에 추가를 클릭합니다.
Header, 바닥글, Notice가 채워진 것을 볼 수 있습니다. 다른 항목을 추가해 결합합니다. 머리글과 바닥글은 " · "로 이어지고, 각 고지는 별도 단락이 됩니다.
- 필요하면 텍스트를 편집한 뒤 저장을 클릭합니다.
알림에 "프로젝트 표시를 저장했습니다."가 표시됩니다. 프로젝트 소유자만 프로젝트 표시를 바꿀 수 있으며, 다른 구성원에게는 읽기 전용으로 보입니다.
지우기는 세 필드를 비웁니다. 표시 없음은 조직에 표시가 있더라도 프로젝트의 표시를 끕니다.
조직 표시 설정
- 계정 메뉴를 열고 조직 설정을 선택한 다음 조직을 엽니다.
- 문서 표시 아래에서 표시 편집…을 클릭합니다.
- 프로젝트와 같은 방식으로 표시를 설정하고 저장을 클릭합니다.
알림에 "조직 표시를 저장했습니다."가 표시됩니다. 자체 표시가 없는 조직의 모든 프로젝트에 적용됩니다. 조직 관리자만 바꿀 수 있습니다.
문서에 자체 표시, 표지, 페이지 번호 지정
- 문서에서 납품 ▾를 열고 페이지 설정…을 선택합니다.
- 표시 아래에서 하나를 선택합니다.
- 프로젝트 또는 조직 표시(기본값): 아래 줄에 문서가 쓰는 표시가 표시됩니다.
- 자체 표시: 프로젝트와 같은 방식으로 머리글, 바닥글, 고지를 설정합니다.
- 표시 없음: 문서와 그 내보내기에 표시가 붙지 않습니다.
- 나머지를 채웁니다.
- 버전과 Prepared by가 있는 Cover page. 표지에는 고지도 표시됩니다.
- Word 내보내기의 Page numbers("Page X of Y").
- 적용을 클릭합니다.
알림에 "페이지 설정을 저장했습니다."가 표시됩니다. 머리글과 바닥글은 문서의 위와 아래에, 고지는 제목 아래에 나타납니다. ⌘Z / Ctrl+Z로 변경을 한 단계에 실행 취소합니다.
가장 가까운 표시가 적용됩니다. 문서 자체의 표시, 없으면 프로젝트의 표시, 그것도 없으면 조직의 표시입니다.
표시가 인쇄되는 곳
- 문서 보기와 인쇄 또는 PDF…: 각 페이지 위와 아래의 머리글과 바닥글, 제목 아래의 고지.
- Word 내보내기(납품 ▾ → {template} (Word), 또는 모든 내보내기…의 Document (Word)): 머리글과 바닥글이 모든 페이지에 반복되고, 선택했다면 페이지 번호가 붙으며, 표지가 일반 제목을 대신합니다. 문서의 라이브 매트릭스 블록은 위에 제목이 있는 Word 표가 되며, 같은 열 너비와 I/A/D/T 머리글, 빨간색으로 음영 처리된 공백을 유지합니다.
- 매트릭스 내보내기와 Traceability matrix (Word) 또는 (HTML).
- 기타 Word 파일: ICD 문서, 프레젠테이션, 다이어그램, Breakdown (Word) 내보내기는 모든 페이지에 머리글과 바닥글을, 제목 아래에 고지를 넣습니다.
- Excel 보고서: 머리글과 바닥글은 각 시트의 페이지 머리글과 바닥글에 들어가며, Excel은 페이지 레이아웃 보기에서 표시하고 인쇄합니다.
- CSV: Table (CSV)에서 첫 줄에 표시 표기를 선택할 때만. 기본적으로 꺼져 있으므로 파일을 그대로 다시 가져올 수 있습니다.
- 다이어그램 이미지: PNG와 SVG 내보내기는 다이어그램 위에 머리글이 있는 띠를, 아래에 바닥글과 고지가 있는 띠를 받습니다. 웹 페이지 (HTML) 내보내기는 페이지 위와 아래에 표시합니다. 미리 보기 이미지와 문서 안의 다이어그램 그림에는 표시가 붙지 않습니다.
- 프레젠테이션: PowerPoint, 웹 페이지, PNG, SVG 슬라이드는 모든 슬라이드에 머리글과 바닥글을, 첫 슬라이드에 고지를 표시합니다.
- 편집본에는 자체 페이지 설정이 있으며, 편집본을 내보낼 때 사용됩니다.
모델 검사
모델 검사는 삭제된 것을 가리키는 라이브 값이나 라이브 표를 보고합니다(규칙 Global.7, "없는 대상을 가리키는 실시간 값").
- 엔터티가 삭제된 Live Value에는 "{Entity: … Not found}"가 표시됩니다.
- 범위 문서가 삭제된 매트릭스 블록, 테스트 스위트나 테스트 주기가 삭제된 테스트 보고서 블록, 또는 관계가 더 이상 없는 사용자 지정 매트릭스.
- 쿼리가 존재하지 않는 클래스, 레이블, 관계 또는 문서를 가리키는 Count or Total 또는 Live Table.
- 항목, 그림 또는 표가 삭제된 Cross-Reference.
설명을 열고 라이브 값을 편집하거나 제거하거나, 존재하는 대상으로 다시 삽입합니다. 모델 검사를 참조합니다.
팁
- RVTM이나 VCRM을 사양서 끝에 검증 섹션으로 넣습니다. 검토 때까지 최신 상태로 유지됩니다.
- 검토 패키지에는 편집본을 만들고 자체 페이지 설정에서 표지와 표시를 지정합니다.
- 표시를 해 줄 검토 위원회를 위해 VCRM을 Excel로 내보내고, 라이브 블록은 문서에 둡니다.
- 통합 수준별로 구성된 검증 계획서에는 검증 수준별 VCRM을 사용하고, 먼저 각 요구사항의 검증 수준을 설정합니다.
- 인터페이스 통제 문서에는 시스템 Asset으로 범위를 지정한 인터페이스 매트릭스를 삽입하여, 그 하위 항목과 Conduit이 대각선과 셀에 나타나게 합니다.