검증
모델 검사
전체 모델에 대해 75개의 규칙 기반 검사와 사용자 규칙 세트를 실행하고, 심각도, 클래스, 규칙, 레이블로 발견 사항을 좁히고, 그 자리에서 수정하고, 의도된 것은 무시하고, 각 규칙의 엄격도를 설정합니다.
이 페이지의 내용
개요
검증 → 모델 검사는 프로젝트의 모든 항목에 규칙 카탈로그를 실행하고 각 규칙이 찾은 것을 나열합니다. 규칙은 모델을 신뢰하거나 검토하기 어렵게 만드는 빈틈을 찾습니다: 빠진 이름과 번호, 따로 떨어진 항목, 아무도 수행하지 않는 Action, 아무것도 운반하지 않는 인터페이스, 할당되지 않았거나 검증되지 않은 요구사항, 대응 계획이 없는 위험, 임계값에 못 미치는 척도.
모델이 바뀔 때마다 검사가 다시 실행되므로 페이지, 홈의 모델 검사 카드, 검증의 배지가 항상 일치합니다.
개념
- 규칙: 번호(예: Requirement.10), 찾는 것을 밝히는 제목, 좋은 모델의 모습에 대한 설명, 수정 방법이 있는 검사 하나입니다. 규칙은 검사하는 클래스별로 묶입니다: Global(모든 항목), Action, Asset, Conduit, Input/Output, Requirement, Risk, Test Case, Measure.
- 발견 사항: 규칙 하나를 어긴 항목 하나입니다. 발견 사항은 관련 항목을 지목할 수 있습니다. 예: 이름이 중복된 항목이나 상위 항목의 자식.
- 심각도: 각 규칙은 오류 또는 경고로 보고하거나, 무시로 설정되어 실행되지 않습니다. 기본값은 경고이며, 스키마 사본이 LML 2.0 이전인 프로젝트의 LML 2.0 규칙 Global.10과 Global.11은 예외입니다(규칙 참조).
- 무시된 발견 사항: 한 항목에 대해 수용한 발견 사항입니다. 더 이상 계산되지 않으며, 무시된 항목 표시가 복원과 함께 나열합니다.
- 적용되는 검사: 해당 클래스의 항목 하나 이상에 실행된 규칙입니다. 머리글 줄은 적용되는 검사 중 발견 사항이 없는 것이 몇 개인지 셉니다.
- 규칙 세트: 이름이 붙은 사용자 규칙 그룹으로, 프로젝트에 저장되며 전체를 한 번에 켜고 끕니다. 그 규칙은 기본 제공 검사와 함께 실행되며, 발견 사항은 같은 목록, 수정, 무시를 사용합니다. 규칙 세트를 참조하십시오.
사용 방법
검토 전마다, 대량 가져오기 후, 그리고 홈에 모델 검사 오류가 표시될 때마다 검사를 실행합니다. 검사는 한 가지 질문에 답합니다: 다른 사람이 읽기 전에 모델에서 무엇을 손봐야 하는가?
발견 사항 처리하기
- 검증 → 모델 검사를 엽니다. 머리글 줄에 예를 들어 "적용되는 검사의 84% 통과"와 함께 오류 및 경고 수, 지난 실행 이후의 변화가 표시됩니다.
- 목록은 규칙별로 묶이며 오류가 먼저 나옵니다. 규칙 제목을 클릭하면 열리며, 설명에 그 규칙이 중요한 이유가 나옵니다.
- 각 발견 사항에서 수정을 클릭합니다. 수정 대화 상자에 항목, 규칙, 제안된 수정이 표시됩니다: 채울 필드, 추가할 관계, 병합할 중복 항목, 또는 항목이나 그 다이어그램을 여는 버튼.
- 수정을 저장합니다. 발견 사항이 사라지고 개수가 갱신됩니다.
- 의도된 발견 사항(예: 두 상위 항목 아래에서 재사용되는 Action)이면 무시를 클릭합니다.
한 영역에 집중
- 왼쪽 패싯의 심각도 아래에서 오류를 선택하면 오류만 표시됩니다.
- 클래스 아래에서 클래스(발견 사항이 있는 항목의 클래스)를, 규칙 아래에서 규칙을, 레이블 아래에서 레이블을 선택합니다. 한 패싯 안의 선택은 OR로, 패싯끼리는 AND로 결합됩니다. 각 값에 발견 사항 수가 표시됩니다.
- 발견 사항 필터에 입력하여 항목 이름이나 규칙 제목과 일치시킵니다.
- 모두 다시 표시하려면 패싯 지우기를 클릭합니다.
한 항목의 발견 사항을 함께 검토
- 필터 옆에서 Group by entity를 선택합니다.
- 각 항목이 모든 발견 사항과 함께 번호 순서로 한 번씩 나열됩니다. 오류가 있는 항목은 제목에 오류 배지가 표시됩니다.
실습 예제: CubeSat EO-1 데모
- CubeSat EO-1 데모 프로젝트를 열고 검증 → 모델 검사로 갑니다.
- 클래스 아래에서 Requirement를 선택합니다. 남은 규칙은 상위 항목이 없거나, 할당이 없거나(Requirement.8), 검증하는 테스트 케이스가 없는(Requirement.10) 요구사항을 보여 줍니다.
- Requirement.10을 열고, 발견 사항에서 수정을 클릭하고, 이를 검증하는 테스트 케이스를 연결합니다. 발견 사항이 목록에서 빠지고 머리글 줄의 수치가 올라갑니다.
- Group by entity를 선택하면 한 요구사항의 남은 발견 사항을 한꺼번에 볼 수 있습니다.
나만의 규칙 작성
- 페이지 머리글에서 규칙 집합…을 클릭한 다음 + 새 규칙 세트를 클릭합니다. 세트 이름(예: "Program Rules")을 지정하고 확인을 클릭합니다.
- 세트 아래에서 + 규칙 추가를 클릭합니다. 규칙 편집기가 ID R1로 열립니다.
- 규칙이 찾는 것을 말하는 이름을 입력합니다. 예: "Requirements with no verifying test case".
- 적용 대상에서 Requirement를 선택합니다.
- 다음 경우 항목 보고에서 관계가 없음을 선택한 다음 관계에서 verified by를 선택합니다.
- 심각도를 오류로 설정하고 메시지를 씁니다. 예: "Link the test case that verifies the requirement."
- 필드 아래의 미리 보기를 읽습니다. 예: "현재 항목 3개 보고: SYS-2 Top Speed, …". 저장을 클릭합니다.
- 닫기를 클릭합니다. 규칙의 발견 사항이 목록의 R1 아래에 오류부터 나타납니다. 수정을 클릭하여 테스트 케이스를 연결하면 발견 사항이 목록에서 빠집니다.
단위가 있는 질량 예산 검사
- CubeSat EO-1 데모에서 규칙 집합…을 열고 + 새 규칙 세트를 클릭하여 이름을 "Mass Budget"으로 지정합니다.
- + 규칙 추가를 클릭합니다. 이름을 "Assemblies over their mass allocation"으로 지정하고 적용 대상에서 Asset을 선택합니다.
- 다음 경우 항목 보고에서 관련 값의 합계를 특정 값과 비교를 선택합니다. Function을 합계로, 관계를 decomposed by로, 각 관련 항목의 값을 Mass로, 비교를 is more than으로, 비교 대상을 Mass Allocation으로 설정합니다.
- 심각도를 오류로 설정하고 저장을 클릭한 다음 닫기를 클릭합니다.
- 부품 무게가 할당보다 큰 조립품이 나열됩니다. 예: "Total Mass of "decomposed by" 2.34 kg is more than Mass Allocation 1.35 kg". 그램과 킬로그램 단위의 질량은 합산되며, 미터로 입력된 질량은 "Cannot add mass and length: the dimensions differ (kg vs m)."로 나열됩니다.
다른 프로젝트와 규칙 공유
- 규칙 집합…에서 세트 옆의 내보내기를 클릭합니다.
program-rules.holarch-rules.json같은 이름의 파일이 다운로드됩니다. - 다른 프로젝트에서 규칙 집합…을 열고 가져오기…를 클릭한 다음 파일 선택…(또는 파일의 텍스트 붙여넣기)을 하고 가져오기를 클릭합니다.
- 라이브러리를 통해 공유하려면 라이브러리 프로젝트에 규칙 세트를 두고 릴리스를 게시합니다. 그 라이브러리를 사용하는 프로젝트에서 라이브러리에서…를 클릭하고, 세트를 선택하고, 복사를 클릭합니다.
- 라이브러리가 그 세트가 포함된 새 릴리스를 게시하면 규칙 집합…의 사본 옆에 "A newer version is available"이 표시됩니다. 업데이트…를 클릭하고, 변경 사항을 검토하고, 양쪽에서 바뀐 각 규칙에 대해 내 것 유지 또는 라이브러리 것 사용을 선택한 다음 업데이트를 클릭합니다. 사본에 대한 다른 편집은 유지됩니다.
팁
- 팀이 차단 요인으로 보는 규칙은 설정에서 오류로 설정하여 홈에 문제로 나열되게 합니다.
- 발견 사항은 의도된 경우에만 무시하고, 그 이유를 항목의 설명이나 댓글에 남깁니다. 무시된 항목 표시로 검토자가 무엇이 수용되었는지 볼 수 있습니다.
- 가져오기 후 이름 관련 발견 사항이 길게 나오면 대개 데이터베이스에서 이름을 편집하는 것이 가장 빠릅니다.
- 베이스라인을 저장하기 전에 검사를 실행하여 베이스라인에 알려진 빈틈이 담기지 않게 합니다.
페이지
페이지 머리글
| 컨트롤 | 기능 |
|---|---|
| 내보내기… | Findings (CSV)가 있는 내보내기 대화 상자를 엽니다: 무시되지 않은 모든 발견 사항과 규칙, 심각도, 제목, 항목 id, 번호, 이름, 클래스, 메모, 관련 항목. |
| 설정 | 각 규칙의 심각도와 수준당 하위 항목 수를 설정합니다(설정 참조). |
| ↻ 검사 실행 | 모든 검사를 다시 실행하고 개수를 마지막 실행으로 기록합니다. |
머리글 줄
- "적용되는 검사의 N% 통과": 발견 사항 중 오류가 있으면 빨간색, 경고만 있으면 황색, 고칠 것이 없으면 녹색.
- 발견 사항, 오류, 경고의 수.
- 이 기기에서의 마지막 실행 이후 변화. 예: "3 findings fewer than the last run." 마지막 실행은 페이지를 열거나 떠날 때, 그리고 ↻ 검사 실행을 클릭할 때 기록됩니다. 첫 방문에는 "First run on this device."가 표시됩니다.
큰 프로젝트에서는 검사가 백그라운드에서 실행되므로 페이지를 계속 사용할 수 있습니다. 첫 방문에는 "Running the model checks…"가 표시되고, 이후 방문에는 새 결과가 준비될 때까지 이전 발견 사항이 표시되며, 1초보다 오래 걸리는 실행에는 진행 카드가 표시됩니다.
도구 모음
- 규칙별로 그룹화(기본값) 또는 Group by entity. 선택은 이 기기에 기억됩니다.
- 발견 사항 필터: 항목 이름, 규칙 번호, 규칙 제목과 일치시킵니다.
- 모두 펼치기와 모두 접기는 모든 그룹을 열거나 닫습니다.
패싯
| 패싯 | 값 |
|---|---|
| 심각도 | 오류, 경고 |
| 분류 | 발견 사항이 있는 각 항목의 클래스 |
| 규칙 | 발견 사항이 있는 각 규칙(번호와 제목) |
| 레이블 | 발견 사항이 있는 항목의 각 레이블 |
| 무시됨 | 무시된 항목 표시는 무시된 발견 사항을 Ignored 표시와 복원과 함께 목록에 추가합니다 |
개수는 다른 패싯과 필터를 따르므로, 값을 선택하면 무엇이 남는지 보여 줍니다.
발견 사항
각 발견 사항에는 항목(항목별로 묶으면 규칙), 메모(예: "Vague words: adequate, TBD" 또는 "14 children"), 관련 항목, 그리고 수정과 무시 버튼(무시된 발견 사항이면 복원)이 표시됩니다. 무시나 복원은 실행 취소 한 번으로 되돌립니다.
수정
| 해결 | 사용처 | 기능 |
|---|---|---|
| 필드 편집 | 이름, 번호 또는 설명 누락. 동사 및 명사 검사 | 현재 값으로 필드를 엽니다. |
| 대문자로 | 소문자로 시작하는 이름 | 첫 글자를 대문자로 바꾼 이름을 제안합니다. |
| 관계 추가 | 상위 항목, 수행자, 입력, 출력, Conduit, 표준, 추적 누락 | 스키마가 그 관계에 허용하는 항목을 나열합니다. 선택하고 관계 추가를 클릭합니다. |
| 병합 | 비슷한 이름, 자식이 하나뿐인 경우 | 항목 하나를 남기고 다른 항목의 모든 관계를 그 항목으로 옮기고, 설명을 합치고, 다른 항목을 삭제합니다(실행 취소 한 번으로 모두 되돌림). |
| 관련 항목 삭제 | 사용된 후에 생성되는 입력이 있는 동작 | 존재하기 전에 소비되는 입력/출력을 삭제합니다. |
| traced to 추가 | 관계 없는 엔터티를 언급하는 요구사항 | 요구사항에서 그 텍스트가 언급하는 각 항목으로 traced to를 추가합니다. |
| Issue 만들기 | 연결된 이슈가 없는 실패한 테스트 케이스 | 테스트 케이스와 그것이 검증하는 요구사항에 연결된 Issue를 만듭니다. |
| 열기 | 긴 자식 목록, 교환, 표준, 임계값, 스키마가 허용하지 않는 관계 | 항목이나 그 다이어그램을 엽니다. |
| UAF 뷰 열기 | 표시할 수 없는 UAF 뷰 | 루트의 뷰와 그 문제를 나열하고 첫 번째 뷰를 엽니다. |
설정
- 수준당 하위 항목 수: Action.9와 Asset.9는 자식이 이 수보다 많은 상위 항목을 보고합니다. 기본값은 9로, 사람이 한 수준에서 약 7 ± 2개 항목을 다룬다는 지침에서 왔습니다. 허용 값은 2–99이며, 다른 값에는 "수준당 하위 항목 수는 2에서 99 사이의 정수여야 합니다."가 표시됩니다.
- 규칙별 심각도: 오류, 경고 또는 무시. 무시된 규칙은 실행되지 않습니다.
- 기본값 복원은 모든 규칙을 기본값(경고. Requirement.11은 무시. 스키마 사본이 LML 2.0 이전인 프로젝트에서는 Global.10과 Global.11도 무시)으로, 수준당 하위 항목 수를 9로 되돌립니다.
설정은 프로젝트에 저장되고, 프로젝트의 모든 사람과 공유되며, 실행 취소할 수 있습니다.
규칙 세트
페이지 머리글의 규칙 집합…은 규칙 세트 대화 상자를 엽니다. 사용자 규칙은 모델 검사에서 기본 제공 검사와 함께 실행됩니다. 그 발견 사항에는 규칙의 ID(예: R1)와 이름이 표시되고, 머리글 줄에 계산되고, 패싯의 규칙 아래에 나타나며, 다른 발견 사항처럼 수정, 무시, 내보내기…를 사용합니다. 규칙 세트는 프로젝트에 저장되고, 프로젝트의 모든 사람과 공유되며, 모든 변경은 실행 취소 한 단계입니다.
규칙 세트 대화 상자
| 컨트롤 | 기능 |
|---|---|
| + 새 규칙 세트 | 이름을 묻고 켜진 상태의 빈 세트를 추가합니다. |
| 가져오기… | 규칙 세트 파일의 규칙 세트를 추가합니다: 파일 선택… 또는 텍스트 붙여넣기 후 가져오기. 모든 규칙을 먼저 검사하며, 문제가 있는 파일은 거부되고 문제가 나열됩니다. 이미 사용된 이름에는 " (2)"가 붙습니다. |
| 라이브러리에서… | 이 프로젝트가 사용하는 라이브러리의 릴리스에 있는 규칙 세트를 나열합니다. 선택하고 복사를 클릭합니다. 사본은 라이브러리와 릴리스를 기억합니다. |
| 업데이트… | 복사한 세트의 라이브러리가 그 세트가 포함된 새 릴리스를 게시하면 그 옆에 표시됩니다("A newer version is available"). 라이브러리에서 추가, 변경, 제거된 규칙, 유지되는 내 편집, 여기와 라이브러리 양쪽에서 바뀐 규칙을 미리 보여 줍니다. 그런 규칙마다 내 것 유지 또는 라이브러리 것 사용을 선택한 다음 업데이트를 클릭합니다. 실행 취소 한 번으로 모두 되돌립니다. |
| 세트 옆의 확인란 | 세트를 켜거나 끕니다. 꺼진 세트는 실행되지 않습니다. |
| 이름 바꾸기… | 세트 이름을 바꿉니다. |
| 내보내기 | 세트를 JSON 규칙 세트 파일로 다운로드합니다. |
| 삭제 | 확인 후 세트와 그 규칙을 삭제합니다. 실행 취소하면 복원됩니다. |
| + 규칙 추가, 편집, 삭제 | 세트에 규칙을 추가하거나, 변경하거나, 삭제합니다. |
이 프로젝트에서 실행할 수 없는 규칙(예: 스키마에 없는 클래스나 관계를 지정한 규칙)은 이름 아래에 문제를 빨간색으로 표시하고 아무것도 보고하지 않습니다.
규칙 편집기
| 필드 | 설정하는 것 |
|---|---|
| 이름 | 규칙 발견 사항의 제목: 규칙이 찾는 것. |
| ID | 세트 안에서 짧고 고유한 값. 예: R1 또는 SYS-NUM. 문자, 숫자, 점, 대시, 밑줄로 최대 40자. |
| 적용 대상 | 모든 항목, 클래스(하위 클래스 포함: Test Case도 Action임), 또는 SysML v2 프로젝트에서는 Part나 Requirement 같은 모델 종류. |
| 다음과 일치하는 항목만 | 선택 사항: 항목을 먼저 좁히는 데이터베이스 필터 언어의 필터. 예: is:leaf. |
| 다음 경우 항목 보고 | 아래의 조건. |
| 심각도 | 오류 또는 경고. |
| 메시지 | 수정 대화 상자에 표시되는, 해야 할 수정. |
필드 아래의 줄은 규칙이 현재 몇 개의 항목을 보고하는지 말하고 처음 다섯 개의 이름을 보여 줍니다.
| 조건 | 필드 | 항목을 보고하는 경우 |
|---|---|---|
| 속성이 비어 있음 | 속성 | 속성에 값이 없습니다. |
| 속성이 패턴과 일치함 | Attribute, Pattern, Ignore case | 속성의 텍스트에 패턴(정규식)과 일치하는 부분이 있습니다. |
| 속성이 패턴과 일치하지 않음 | Attribute, Pattern, Ignore case | 속성의 텍스트에 일치하는 부분이 없습니다. 예: SYS-로 시작해야 하는 번호에 대한 ^SYS-\d+$. |
| 관계가 없음 | Relationship, Of items of | 항목에 그 관계의 연결(그 클래스 항목으로의)이 없습니다. |
| 관계가 있음 | Relationship, Of items of | 항목에 그런 연결이 있습니다. |
| 관련 항목 수가 N개 이상 | Relationship, Of items of, N | 항목에 관련 항목이 N개 이상 있습니다. 예: 자식이 9개보다 많음. |
| 관련 항목 수가 N개 이하 | Relationship, Of items of, N | 항목에 관련 항목이 N개 이하로 있습니다. |
| 값이 범위 밖에 있음 | Attribute, Minimum, Maximum, Unit | 속성의 숫자가 최솟값보다 작거나 최댓값보다 큽니다. 한쪽 경계를 비우면 열린 범위가 됩니다. |
| 값이 범위 안에 있음 | Attribute, Minimum, Maximum, Unit | 속성의 숫자가 경계를 포함하여 범위 안에 있습니다. |
| 관련 값의 합계를 특정 값과 비교 | Function, Relationship, Of items of, Value of each related item, Comparison, Compare with | 관련 항목에 대한 값의 합계, 최소 또는 최대(또는 항목 수)가 항목의 속성(예: Mass Allocation)이나 단위가 붙은 값(12 kg)보다 크거나, 이상이거나, 작거나, 이하이거나, 같거나, 다릅니다. 값이 없는 관련 항목은 건너뜁니다. |
| 식이 일치함 | 식 | 항목이 식과 일치합니다. |
속성은 항목에서와 같은 이름으로 지정합니다: 이름, Number, 설명(SysML v2 프로젝트에서는 Short Name과 Documentation) 또는 클래스의 임의 속성. SysML v2 프로젝트에서는 mass 같은 요소의 attribute 사용도 지정할 수 있습니다. 클래스에 그런 속성이 없는 항목은 건너뜁니다. LML 항목의 값에는 그 항목이 specified by되는 Characteristic(Value 2.4, Units kg인 Mass Characteristic은 2.4 kg으로 읽힘)과 예산 할당(예산의 Mass Allocation)도 포함됩니다. 단위가 없으면 범위는 값의 앞쪽 숫자를 읽고(1,500 kg과 1500 [kg]은 1500으로 읽힘) 숫자가 아닌 값은 건너뜁니다. kg 같은 단위가 있으면 값을 먼저 변환하며(25000 g은 25 kg으로 읽힘), 3 m 같은 다른 종류의 값은 그 자체로 발견 사항이 됩니다: "Cannot compare length and mass: the dimensions differ (m vs kg)." 합계와 식도 같은 방식으로 단위를 변환하고 불일치를 같은 방식으로 보고하며, 조용히 비교하는 일은 없습니다.
식 규칙
식은 데이터베이스 필터 막대의 필터 언어로 씁니다. 따라서 그곳에서 문제 항목을 찾는 필터는 규칙으로도 작동합니다. 일치하는 모든 항목이 보고됩니다. 예:
| 식 | 보고서 |
|---|---|
class:Requirement is:leaf NOT relationship:"verified by" | 어떤 테스트 케이스도 검증하지 않는 말단 요구사항. |
class:Requirement Requirement:"Status=Draft" | 아직 Draft인 요구사항. |
class:Action is:root NOT relationship:"performed by" | 아무것도 수행하지 않는 최상위 Action. |
class:Asset (name:%TBD% OR description:TBD) | 이름이나 설명에 TBD가 있는 Asset. |
class:Asset value:"sum(decomposed by → Mass) > Mass Allocation" | 어떤 단위 조합이든, 부품 무게가 할당보다 큰 조립품. |
단위를 포함한 산술: value:"Mass * 1.1 <= 12 kg" 또는 value:"sum(decomposed by → Mass) > Mass Allocation"은 항목의 값과 관련 항목에 대한 합계(sum, min, max, count)를 +, -, *, /, 괄호, 숫자 뒤의 단위(12 kg, 9.81 [m/s^2])로 비교합니다. Asset:"Mass>2 kg"처럼 단위가 있는 속성 비교도 변환됩니다.
조건: 자유 텍스트, name:(%는 임의 텍스트와 일치), number:(*는 임의 텍스트와 일치), description:, class:, label:, relationship:"…", status:, id:, under:"<number>", is:root, is:leaf, is:orphan, is:top, is:locked, is:diagram, Requirement:"Priority>=3" 같은 속성 비교(=, ~ 포함, <, <=, >, >=. 값이 없는 =는 비어 있음을 뜻함), AND, OR, NOT, 괄호. 알 수 없는 클래스처럼 프로젝트에서 아무것도 가리키지 않는 조건은 문제로 표시됩니다.
규칙 세트 파일
규칙 세트 파일은 "format": "holarch-rule-set", "version": 1, name, 선택 사항인 description, rules 목록이 있는 JSON입니다. 각 규칙에는 id, name, severity, message, 선택 사항인 target({"class": "Requirement"}), 선택 사항인 where 필터, check가 있습니다. 정확한 형태는 세트를 내보내 확인합니다. 같은 파일이 공개 API와 MCP의 모델 검사에서도 실행됩니다. SysML v2 프로젝트에서도 실행되며, 이때 API와 MCP는 프로젝트의 규칙 세트만 실행하고(기본 제공 규칙은 앱에서 실행), Holarch가 connection과 flow에서 읽는 관계(connected by, transfers, generates, receives)에 대한 규칙은 앱에서만 실행됩니다.
규칙
| 규칙 | Heading | 좋은 모델 |
|---|---|---|
| Global.1 | 같거나 거의 같은 이름 | 한 클래스 안에서 두 엔터티가 같은 이름을 갖지 않습니다. 이름은 언어에 관계없이 대소문자, 공백, 문장 부호, 문자 폭을 무시하고 비교합니다("ABS制御"는 "ABS制御"와 같음). 악센트가 있는 문자는 구별합니다("Größe"와 "Grüße"는 다름). |
| Global.2 | 소문자로 시작하는 이름 | 모든 엔터티 이름은 대문자로 시작합니다. |
| Global.4 | 클래스 안의 중복 번호 | 한 클래스 안에서 모든 번호는 고유합니다. |
| Global.5 | 이름이나 설명의 모호한 단어 | 이름과 설명에는 정확한 단어를 씁니다. |
| Global.6 | 관계가 없는 엔터티 | 모든 엔터티에는 관계가 있습니다. |
| Global.7 | 없는 대상을 가리키는 실시간 값 | 실시간 값, 매트릭스 블록, 실시간 표(표, 개수, 합계)와 설명의 상호 참조는 존재하는 엔터티, 문서, 클래스, 레이블, 관계, 그림, 표를 가리킵니다. |
| Global.8 | 표시할 수 없는 UAF 뷰 | 모든 UAF 뷰는 뷰 유형이 허용하는 루트, 클래스, 관계를 사용합니다. |
| Global.9 | 스키마가 허용하지 않는 관계 | 모든 관계는 스키마가 그 관계 유형에 허용하는 클래스를 연결합니다. |
| Global.10 | 이름도 번호도 없는 엔터티 | 모든 엔터티에는 이름이나 번호가 있습니다. |
| Global.11 | 속성의 선택지에 없는 값 | 모든 열거형 및 다중 선택 값은 속성의 선택지 중 하나이며 한 번만 선택됩니다. |
| Action.1 | 동사로 시작하지 않는 Action 이름 | 모든 Action 이름은 동사로 시작합니다. |
| Action.2 | 소문자로 시작하는 Action 이름 | 모든 Action 이름은 대문자로 시작합니다. |
| Action.3 | 이름이 없는 동작 | 각 동작에는 이름이 있습니다. |
| Action.4 | 번호가 없는 동작 | 각 동작에는 번호가 있습니다. |
| Action.5 | 설명이 없는 동작 | 각 동작에는 설명이 있습니다. |
| Action.6 | 부모나 자식이 없는 동작 | 모든 동작에는 부모나 자식이 있습니다. |
| Action.7 | 자식이 하나뿐인 동작 | 자식이 하나뿐인 동작이 없습니다. |
| Action.9 | 자식이 9개를 넘는 동작 | 자식이 9개를 넘는 동작이 없습니다. |
| Action.10 | 부모가 여러 개인 동작 | 부모가 여러 개인 동작이 없습니다. |
| Action.11 | 수행하는 자산이 없는 동작 | 각 동작은 어떤 자산이 수행합니다. |
| Action.12 | 아무것도 생성하지 않는 동작 | 모든 동작은 입력/출력을 생성합니다. |
| Action.13 | 아무것도 소비하지 않는 동작 | 모든 동작은 입력/출력을 소비합니다. |
| Action.14 | 입력과 출력이 없는 동작 | 모든 동작은 입력/출력을 소비하거나 생성합니다. |
| Action.15 | 생성하지만 아무것도 소비하지 않는 동작 | 출력을 생성하는 모든 동작은 입력도 소비합니다. |
| Action.16 | 소비하지만 아무것도 생성하지 않는 동작 | 입력을 소비하는 모든 동작은 출력도 생성합니다. |
| Action.17 | 사용된 후에 생성되는 입력이 있는 동작 | 이후 동작이 생성하는 입력/출력을 받는 동작이 없습니다. |
| Action.18 | 요구사항으로 추적되지 않는 동작 | 모든 동작은 요구사항으로 추적됩니다. |
| Action.19 | 끝날 수 없는 루프 | 모든 루프는 끝날 수 있습니다. 루프와, 그 EXIT를 막는 0 % OR 분기를 지목합니다. |
| Asset.1 | 명사가 없는 자산 이름 | 모든 자산 이름은 명사나 명사구입니다. |
| Asset.2 | 소문자로 시작하는 자산 이름 | 모든 자산 이름은 대문자로 시작합니다. |
| Asset.3 | 이름이 없는 자산 | 각 자산에는 이름이 있습니다. |
| Asset.4 | 번호가 없는 자산 | 각 자산에는 번호가 있습니다. |
| Asset.5 | 설명이 없는 자산 | 각 자산에는 설명이 있습니다. |
| Asset.6 | 부모나 자식이 없는 자산 | 모든 자산에는 부모나 자식이 있습니다. |
| Asset.7 | 자식이 하나뿐인 자산 | 자식이 하나뿐인 자산이 없습니다. |
| Asset.9 | 자식이 9개를 넘는 자산 | 자식이 9개를 넘는 자산이 없습니다. |
| Asset.10 | 부모가 여러 개인 자산 | 부모가 여러 개인 자산이 없습니다. |
| Asset.11 | 아무 동작도 수행하지 않는 자산 | 각 자산은 어떤 동작을 수행합니다. |
| Asset.12 | 도관으로 연결되지 않은 자산 | 모든 자산은 도관으로 연결됩니다. |
| Asset.13 | 주고받지만 공통 도관이 없는 자산 | 입력/출력을 주고받는 자산은 도관으로 연결됩니다. |
| Asset.14 | 공통 표준이 없는 상호작용 자산 | 상호작용하는 자산은 같은 표준을 참조합니다. |
| Asset.15 | 아무것도 주고받지 않는 자산 | 모든 자산은 다른 자산과 입력/출력을 주고받습니다. |
| Conduit.1 | 명사로 시작하지 않는 도관 이름 | 모든 도관 이름은 명사로 시작합니다. |
| Conduit.2 | 이름이 없는 도관 | 각 도관에는 이름이 있습니다. |
| Conduit.3 | 번호가 없는 도관 | 각 도관에는 번호가 있습니다. |
| Conduit.4 | 설명이 없는 도관 | 각 도관에는 설명이 있습니다. |
| Conduit.5 | 자산이 두 개를 넘는 도관 | 두 개를 넘는 자산을 연결하는 도관이 없습니다. |
| Conduit.6 | 자산이 두 개 미만인 도관 | 모든 도관은 두 자산을 연결합니다. |
| Conduit.7 | 자산과 공통 표준이 없는 도관 | 도관과 그것이 연결하는 자산은 같은 표준을 참조합니다. |
| Conduit.8 | 아무것도 전달하지 않는 도관 | 각 도관은 어떤 입력/출력을 전달합니다. |
| Conduit.9 | 요구사항으로 추적되지 않는 도관 | 모든 도관은 요구사항으로 추적됩니다. |
| IO.1 | 이름이 없는 입력/출력 | 각 입력/출력에는 이름이 있습니다. |
| IO.2 | 번호가 없는 입력/출력 | 각 입력/출력에는 번호가 있습니다. |
| IO.3 | 설명이 없는 입력/출력 | 각 입력/출력에는 설명이 있습니다. |
| IO.4 | 부모가 여러 개인 입력/출력 | 부모가 둘 이상인 입력/출력이 없습니다. |
| IO.5 | 생성하는 동작이 없는 입력/출력 | 각 입력/출력은 어떤 동작이 생성합니다. |
| IO.6 | 소비하는 동작이 없는 입력/출력 | 각 입력/출력은 어떤 동작이 소비합니다. |
| IO.7 | 사용하는 동작이 없는 입력/출력 | 모든 입력/출력은 어떤 동작이 생성하거나 소비합니다. |
| IO.8 | 한 동작이 생성하고 소비도 하는 입력/출력 | 자신이 생성하는 입력/출력을 소비하는 동작이 없습니다. |
| IO.9 | 자산과 공통 표준이 없는 입력/출력 | 입력/출력과 그것을 주고받는 자산은 같은 표준을 참조합니다. |
| IO.10 | 요구사항으로 추적되지 않는 입력/출력 | 모든 입력/출력은 요구사항으로 추적됩니다. |
| Requirement.1 | 관계 없는 엔터티를 언급하는 요구사항 | 요구사항은 그것이 언급하는 모든 엔터티와 관계로 연결됩니다. |
| Requirement.2 | "shall"이 없는 리프 요구사항 | 모든 리프 요구사항은 "shall"이라는 단어를 씁니다. |
| Requirement.3 | 이름이 없는 요구사항 | 각 요구사항에는 이름이 있습니다. |
| Requirement.4 | 번호가 없는 요구사항 | 각 요구사항에는 번호가 있습니다. |
| Requirement.5 | 설명이 없는 요구사항 | 각 요구사항에는 설명이 있습니다. |
| Requirement.6 | 부모나 자식이 없는 요구사항 | 모든 요구사항에는 부모나 자식이 있습니다. |
| Requirement.7 | 부모가 여러 개인 요구사항 | 부모가 여러 개인 요구사항이 없습니다. |
| Requirement.8 | 충족하는 설계 엔터티가 없는 리프 요구사항 | 모든 리프 요구사항은 Action, Asset, Input/Output 또는 Conduit과 관계로 연결됩니다. |
| Requirement.9 | 여러 입력/출력이 충족하는 요구사항 | 둘 이상의 입력/출력이 충족하는 요구사항이 없습니다. |
| Requirement.10 | 검증하는 테스트 케이스가 없는 리프 요구사항 | 각 리프 요구사항은 Test Case로 검증됩니다. |
| Requirement.11 | EARS 패턴을 벗어난 요구사항 | "shall"이 있는 각 말단 요구사항은 EARS 패턴 중 하나를 따릅니다. 심각도를 설정하기 전까지는 꺼져 있습니다(무시). |
| Risk.1 | 완화 조치가 없는 최고 수준 위험 | 위험 매트릭스의 최고 수준에 있는 각 미해결 위험은 무언가로 완화됩니다. |
| Risk.2 | 통제 수단 변경보다 오래된 위해 요인 수용 | 어떤 위해 요인의 잔여 위험 수용도 그 통제 수단이나 그 검증의 변경보다 앞서지 않습니다. |
| TestCase.1 | 연결된 이슈가 없는 실패한 테스트 케이스 | 실패한 각 Test Case는 Issue에 연결됩니다. |
| Measure.1 | 임계값을 벗어난 Measure | 각 Measure의 예상(또는 현재) 값은 임계값을 충족합니다. |
규칙에 관한 참고:
- 요구사항 작성 규칙은 INCOSE Guide to Writing Requirements를 인용합니다: 모호한 단어(R7 모호한 용어, R8 회피 조항), "shall"(R1 구조화된 문장), 대문자(R39 스타일 가이드). 전체 작성 검사는 요구사항 품질입니다.
- Action 및 Asset 규칙은 Task, 테스트 케이스, 상태 전이, 포트, Resource를 건너뜁니다. Global 규칙은 여전히 적용됩니다.
- 분해된 항목은 그 하위 항목 중 하나라도 수행되거나, 입력을 받거나, 생산하거나, 추적되면 그런 것으로 계산됩니다. 서로를 루프로 분해하는 항목은 함께 계산됩니다.
- Global.9는 각 항목을 한 번 보고하며, 스키마가 허용하지 않는 관계의 반대쪽 끝을 나열하고 메모에 관계와 클래스를 적습니다. 예: "Not allowed: decomposed by → Risk". 스키마가 어느 방향으로든 허용하면 그 관계는 허용된 것으로 봅니다. 그런 관계는 스키마 편집기에서 대상을 제거한 뒤에도 남으며, 가져오기로 들어올 수도 있습니다.
- Global.10과 Global.11은 LML 2.0에서 왔습니다. 엔터티는 이름이나 번호로 식별되며(§2.1), 열거형이나 다중 선택 값은 속성의 목록에서 고릅니다(§2.5.6, §2.5.12). Global.11은 한 항목의 모든 문제를 메모에 담습니다. 예:
Status: "Pending" is not a choice또는Verification Method: "Test" chosen twice. 스키마에 LML 2.0 기본 제공 항목이 있는 곳, 즉 기본 스키마나 Schema → Add New Built-ins… 이후의 프로젝트 자체 사본에서는 둘 다 기본으로 실행됩니다. 스키마 사본이 더 오래된 프로젝트에서는 무시로 시작하므로, LML 1.x로 만든 모델은 이전과 같은 발견 사항을 보여 줍니다. 실행하려면 설정에서 경고나 오류로 설정합니다. 스키마 편집기는 목록을 만들거나 변경할 때 값을 두 개 이상 요구합니다. - 포트는 부품이 아니라 인터페이스 지점입니다. 자식으로 계산되지 않으며, 포트의 Conduit은 그 포트를 소유한 Asset의 것으로 계산됩니다.
- 유스케이스(Use Case 레이블이 붙은 Action)는 동사 규칙과 입력/출력 규칙에서 제외됩니다.
- Requirement.11은 "shall"이 있는 문장을 여섯 가지 EARS 패턴(EARS 템플릿으로 작성)과 대조하여 가장 먼저 고칠 것을 지목합니다. 예: "Event-driven: "When" 조건 뒤, 시스템 이름 앞에 쉼표를 넣으십시오." 다른 문장의 근거와 메모는 검사하지 않습니다.
- SysML v2 프로젝트는 규칙 중 17개를 SysML v2 용어로 실행합니다: Global.1, .2, .4–.8, Requirement.2–.5, .8, .10, .11, Risk.1, TestCase.1, Measure.1. Action, Asset, Conduit, Input/Output 규칙은 적용되지 않으며, 편집기의 진단이 모델의 이름, 타입, 구조를 검사합니다. Requirement 규칙은 requirement 사용을 검사합니다. 예를 들어 Requirement.8은 "아무것도 충족하지 않는 리프 요구사항"(그것을 충족하는 part나 action)으로, Requirement.10은 "검증 케이스가 없는 리프 요구사항"으로 표시됩니다. Global.1, .2, .6은 위험, 작업, 문서처럼 모델 옆에 있는 항목을 검사합니다.
제품 라인 규칙
프로젝트에 Feature나 Configuration이 생기면 모델 검사는 기본 제공 규칙 세트 제품 라인(규칙 ProductLine.1–ProductLine.11과 13–17, 클래스 제품 라인)도 실행합니다. Applies To에 기능이나 구성이 빠진 경우(ProductLine.1), 규칙을 어기거나 불완전한 구성(ProductLine.3), 그 구성에서 검증되지 않은 요구사항이 있는 릴리스됨 구성(ProductLine.16)은 오류이며, 다른 규칙은 경고입니다. ProductLine.10과 11은 모든 구성에서 각 구성의 완전성을 검사합니다. ProductLine.13과 14는 항목의 개정(supersedes)을 검사합니다: 같은 유닛에 대해 둘이 유효한 경우와, 하나도 없는 유닛. 구성 보기에서는 모든 규칙이 그 구성을 검사합니다. 제품 라인과 구성을 참조하십시오.
메시지
| 메시지 | 의미 |
|---|---|
| "발견 사항이 없습니다. 적용되는 모든 검사를 통과했습니다." | 고칠 것이 없습니다. |
| "발견 사항이 없습니다. 발견 사항 N개가 무시되었습니다. 무시된 항목 표시로 나열됩니다." | 남은 발견 사항이 모두 무시되었습니다. |
| "필터와 일치하는 발견 사항이 없습니다. 필터나 패싯을 지우십시오." | 패싯이나 필터가 모든 발견 사항을 숨깁니다. |
| "스키마는 … 클래스에 이 관계를 하나도 허용하지 않습니다" | 수정에 필요한 관계를 프로젝트 스키마가 그 클래스에 허용하지 않습니다. 스키마 편집기에서 추가하거나 다른 방법으로 발견 사항을 고칩니다. |
| "패턴이 올바른 정규식이 아닙니다(…). 바로잡으십시오." | 규칙 편집기나 가져온 파일에 읽을 수 없는 패턴이 있습니다. |
| "ID "…"은(는) 이 규칙 세트에서 이미 사용 중입니다. 다른 ID를 선택하십시오." | 한 세트 안의 두 규칙은 서로 다른 ID가 필요합니다. |
| "관계 "…"이(가) 이 프로젝트의 스키마에 없습니다." | 규칙이 이 프로젝트에 없는 관계를 지정합니다. 바꿀 때까지 아무것도 보고하지 않습니다. |
| "식이 클래스 "…"에 대해 아무것도 가리키지 않습니다." | 식이나 필터가 프로젝트에 없는 클래스, 레이블, 관계 또는 항목을 지정합니다. |
| "버전 N은 지원되지 않습니다. 이 버전의 Holarch는 버전 1을 읽습니다." | 규칙 세트 파일이 더 새로운 Holarch로 작성되었습니다. |
제한 사항
- 목록에는 그룹당 발견 사항이 최대 200개 표시됩니다. 나머지를 보려면 목록을 필터링합니다.
- 규칙 세트에는 규칙을 최대 500개, 파일에는 규칙 세트를 최대 50개와 2 MB까지 담을 수 있습니다. 패턴은 최대 300자이며 값의 처음 20,000자를 검사합니다.
- 마지막 실행 이후의 변화는 프로젝트가 아니라 기기와 브라우저마다 보관됩니다.
- 공개 API와 MCP 도구는 프로젝트 설정으로 같은 발견 사항을 반환하며, 결과를 저장하지 않습니다.