mermaid로 flow chart그리는 법

데이터의 양이 많아지게 되면 블록체인 데이터를 데이터베이스에 저장하게 된다.

이번에는 해당 데이터베이스의 누락 여부를 점검하고 데이터베이스에 대한 관리 권한을 이전하고 나서도 검토를 계속 할 수 있는 프로그램을 제작중이다.

처음에는 간단하게 점검만 하려다 보니 자동화가 필요해져서 자동화를 했는데

팀회의 때 보니 이를 자동화 시키는 프로그램이 필요하다고 했다.

나는 중간에 들어왔다 보니 잘 몰랐지만 아직까지 db적재 데이터의 검토 모듈이 없었다고 하여 이번에 설계를 하게 되었다.

 

어차피 혼자 하는 작업이라 설계 과정 없이 진행하려 했지만 다음의 2가지 이유로 설계서를 작성하였다.

1. 추후 이관 시 설명을 해야 함

2. 팀원 내부의 사람들에게도 공유를 해야 함

3. 상당히 복잡한 프로그램이 나올 것으로 예상 됨

일단 사용한 툴은 mermaid 이며 flow chart를 사용하였다.

먼저 순서도에 대해 조금 찾아봤는데 여기에 정리해 보겠다.

mermaid에서는 차트를 모두 완성시키더라도 다음 명령어들을 통해서 위아래, 왼쪽, 오른쪽 등의 순서를 자유자재로 변경 시킬 수 있다.

개인적으로 TD로 해야 복잡한 설계서에서 그나마 가독성이 있는 것 같다.

 

1. 시작과 끝

처음 시작과 끝의 경우 다음 형태의 모양이 필요하다고 한다.

flowchart LR
    id1([This is the text in the box])

2. 데이터베이스

만약 중간에 데이터베이스와 상호작용하는 부분이 있다면 다음과 같이 표현한다.

flowchart LR
    id1[(Database)]

3. 마름모(선택의 경우)

만약 다양한 선택지가 존재하는 경우 마름모를 선택하면 된다고 한다.

flowchart LR
    id1{This is the text in the box}

4. 입력과 출력

만약 입력이나 출력에 대한 부분일 경우 다음과 같이 작성하면 된다고 한다.

flowchart TD
    id1[/This is the text in the box/]

5. 화살표 중간의 문자

화살표 중간에는 실행 로직에 맞추어 A, B, C, D로 크게 나누고 해당 로직의 순서에 따라 A-1. , A-2. 와 같이 세부적인 순서를 맞추었다.

flowchart LR
    A-- text -->B

6. 그 외의 정보

그 외의 정보는 

목표, 환경, 실행주기, 비교대상 설정, 전체 설계 순서대로 설계 문서를 작성하였다.

추후에 더 복잡해진다면 클래스 별로 상세 설계를 추가할 예정이다.