그래픽 설명 가이드라인
문서의 일관성을 유지하는 것은 매우 중요하며, 이를 위해 스마트 컨트랙트의 프로세스를 시각화하기 위한 구체적인 표준이 개발되었습니다.
그래픽 설명 표기법
메시지 처리 그래프
메시지 처리를 설명하려면 트랜잭션과 메시지에 대한 레이블이 있는 스마트 컨트랙트 그래프와 유사한 그래픽 표현을 사용하는 것이 좋습니다.
트랜잭션 순서가 중요하지 않은 경우 라벨을 생략할 수 있습니다. 이렇게 하면 다이어그램이 단순화되어 메시지 및 계약과 관련된 세부 정보를 더 쉽게 읽고 이해할 수 있습니다.
주석 프리미티브
| 그림 | 설명 |
|---|---|
 | 서클 - 스마트 컨트랙트 엔티티 |
 | 직사각형 - 메시지 엔티티 |
 | 대시 직사각형 - 선택적 메시지 엔티티 |
 | 트랜잭션(숫자 선택 사항) |
 | 배우 |
- 너무 많은 양의 다른 밝은 색상을 사용하지 마세요.
- 점선 테두리를 사용하는 등의 그림 수정을 사용합니다.
- 이해도를 높이기 위해 서로 다른 트랜잭션을 뚜렷한 선 스타일(실선 및 점선)로 표시할 수 있습니다.
메시지 처리 예제
Visio message-processing.vsdx에서 직접 참조를 학습하세요.
형식 및 색상
글꼴
- 다이어그램 내의 모든 텍스트에 간 글꼴 제품군을 사용합니다.
색상 - 조명 모드
- 연필로 그린 손그림(기본 테마)
색상 - 다크 모드
- 글꼴
#e3e3e3 - 배경
#232328 - 조명 하이라이트(화살표 및 구성표 테두리)
#058dd2 - 어두운 하이라이트(화살표 및 구성표 테두리)
#0088cc - InnerBackGround(중첩된 블록의 경우)
#333337
버전 관리 정책
- 다양한 기기에서 가독성을 보장하기 위해 문서의 다이어그램을 SVG 형식으로 설정하여 스키마에 맞게 구성하세요.
- 원본 파일을 프로젝트의 Git 리포지토리에 "/static/visio" 디렉토리에 저장하여 나중에 쉽게 수정할 수 있도록 합니다.
시퀀스 다이어그램
2~3명의 액터 간의 복잡하고 반복적인 커뮤니케이션 체계의 경우 시퀀스 다이어그램을 사용하는 것이 좋습니다. 메시지의 경우 일반적인 동기식 메시지 화살표 표기법을 사용합니다.
예
