목적
여러분만의 앱과 명명 규칙을 위한 출발점으로 Tulip의 사용자 지정 요소 명명 모범 사례를 검토하세요.
변수, 단계, 레코드 등 Tulip의 모든 사용자 지정 요소는 사람이 읽기 쉽고 모호하지 않으며 이해하기 쉬운 방식으로 이름을 지정하여 앱 수명 주기 동안 앱의 사용성을 용이하게 해야 합니다.
모든 요소에 대해 다음과 같은 일반적인 명명 규칙을 채택하는 것이 좋습니다:
- 설명적인 이름
- 약어 없이 단어 전체로 표기
- 각 단어의 첫 글자는 대문자로, 그 다음 글자는 소문자로 사용
- 개별 단어는 공백으로 구분
| 예시 | 이슈 | 더 나은 예제 |
| Done | 비설명적 | 작업 완료 |
| 연산자 이름 | 소문자 및 공백 없음 | 연산자 이름 |
아래 섹션에서는 특정 요소에 대한 보다 자세한 지침을 설명합니다.
변수
변수 이름은 앱에서 고유해야 하지만, 동일한 이름을 Tulip 플랫폼 내에서 재사용할 수 있습니다.
- 이름에 포함되지 않은 변수 유형
- 숫자 변수 이름 옆 괄호 안에 단위 약어 기재
| 예시 | 이슈 | 더 나은 예제 |
| 총 중량 | 약어 및 단위. 규제 대상 업종은 아래 설명을 참조하세요. | 총 중량(g) |
| flt온도F | 이름 입력, 공백 없음 및 잘못된 단위규제 대상 산업의 경우 다음 하위 섹션을 참조하세요. | 온도(°F) |
규제 대상 산업
값과 측정 단위를 두 개의 개별 변수/테이블 레코드 필드(예: "총 중량" 및 "총 중량_UOM")에 저장하는 것이 좋습니다. 자세한 내용은 GxP 앱 구축 모범 사례를 참조하세요.
| 예제 | 이슈 | 더 나은 예제 |
| 온도(°F) | 값 및 측정 단위로 하나의 변수만 사용됨 | Temperature Temperature_UOM |
테이블을 필터링하는 데 사용되는 변수
특정 열과 관련하여 테이블을 필터링하는 데 사용되는 변수의 이름에는 접두사 '필터'를 붙여야 합니다. 이렇게 하면 앱 빌드 시 해당 변수의 사용성이 향상됩니다. 이는 필터링에만 사용되는 변수에 권장됩니다. 앱의 범용 변수는 접두사가 필요하지 않습니다.
| 예시 | 이슈 | 더 나은 예제 |
| 상태 필터 | 접미사 없이 | Filter_Status |
| IPC타임스탬프 필터 | 접미사 대 접두사 | |
| 소문자 및 공백 없음 | Filter_IPC 타임스탬프 |
주요 지표의 변수
CPP/CQA(중요 프로세스 매개변수/중요 프로세스 속성) 또는 KPI와 같은 주요 지표가 있는 앱의 경우 변수 이름에 접두사를 추가하여 변수의 가독성을 개선하세요.
| 예시 | 이슈 | 더 나은 예 |
| CPP 온도 | 접두사가 변수 이름과 명확하게 구분되지 않음 | CPP_Temperature (°C) |
| AssayB_CQA | 접두사 대 접두사로 사용 | CQA_Assay B |
| 가용성 | 주요 지표의 접두사가 누락됨 | KPI_Availability |
Tables
테이블 이름은 변수에 사용된 것과 동일한 명명 규칙을 적용하고 접두사를 사용하여 그룹화해야 합니다. 테이블은 여러/모든 사용 사례 또는 특정 사용 사례와 같은 일반적인 목적에 따라 그룹화해야 합니다. 일반적인 목적의 그룹화에는 '
'를 사용하고 '*'를 사용하지 않는 것이 좋습니다. '*'는 Tulip 라이브러리 앱에서 시작된 테이블을 표시하는 데 사용됩니다.
| 예시 | 이슈 | 더 나은 예제 |
| 인쇄된 lables_table | 접미사 사용 | #인쇄된 레이블 |
| *프린티드_라벨 | '*' 접두사 사용 | #인쇄된 레이블 |
트리거
기본 "이름 없는 트리거" 이름을 사용하지 않는 것이 좋습니다. 대신 트리거의 이름은 몇 단어로 트리거의 기능을 설명해야 합니다.
| 예시 | 이슈 | 더 나은 이름 |
| 이름 없는 트리거 | 기본 이름 | 결함 카운터 증가 |
| 상태 확인 | 컨텍스트가 너무 적음 | 주문 배송 상태 확인 |