동영상 버전

소개

엔지니어가 설계서를 쓸 때 마크 다운 형식으로 쓰는 것도 늘어 왔는지 생각합니다 (라고 Qiita는 마크 다운이고).

마크다운으로 그림을 쓸 때 유용한 것이 PlantUML입니다.

UML은 설계뿐만 아니라 요구 사항 정의에서도 사용할 수 있습니다. 비 엔지니어에게도 꼭 추천하고 싶습니다.

오픈 소스 종합 개발 환경 Visual Studio Code에 PlantUML을 설치하는 방법을 소개합니다.

( note 기사 에서 기술보다는 Qiita에도 전기하고 있습니다)

장점

마크다운에 기재하면 버전(Git) 관리했을 때 버전 간의 차이를 볼 수 있다(Diff를 취할 수 있다)

형식이 고정되어 가시성 향상

어쨌든 가벼운 (마크 다운은 단지 텍스트)

환경

macOS Catalina 10.15.7 (2020/10/13)

절차

웹 사이트에서 VSCode 다운로드 및 설치

명령 줄에서 graphviz를 설치하고 설정

명령 줄에서 plantuml을 설치하고 설정

VSCode에서 UML을 작성하고 미리보기

1. 웹 사이트에서 VSCode를 다운로드하여 설치

1-1. htps : // 여기. 가 m / 도 w 응아 d 에 액세스

1-2. 사과 클릭

1-3. ZIP을 해동한다 (분명히 자동으로 해준다)

1-4. 애플리케이션으로 이동

1-5. 더블 클릭으로 시작

터미널? brew는 무엇입니까?

(아는 분은 날려주세요)

・터미널은 텍스트로 입력해 여러가지 할 수 있는 공각 기동대 같은 녀석





(오자는 용서해)

・brew는 mac의 터미널에서 사용할 수 있는 툴의 패키지 매니저(편하게 설치할 수 있는 툴)



아무래도 모르는 때는 자랑스러운 사람에게 부탁합시다 웃음

설치 방법 등은 생략합니다.

2. 명령줄에서 graphviz를 설치하고 설정

2-1. 터미널 열기

2-2. 설치

$ brew install graphviz と入力

2-3. 설정(심볼릭 링크 붙이기)

다음 두 줄 입력

$ echo 'export PATH="/usr/local/opt/icu4c/bin:$PATH"' >> /Users/$(whoami)/.bash_profile
$ echo 'export PATH="/usr/local/opt/icu4c/sbin:$PATH"' >> /Users/$(whoami)/.bash_profile

3. 명령줄에서 plantuml 설치 및 구성

3-1. 설치

$ brew install plantuml と入力

3-2. 끝나면 다음을 실행

$ echo 'export PATH="/usr/local/opt/openjdk/bin:$PATH"' >> /Users/$(whoami)/.bash_profile

4. VSCode에서 UML을 작성하고 미리보기

4-1. 확장자는 ".pu"

샘플은 "sample.pu"

4-2. 저장

4-3. 미리보기

option + d를 누릅니다.

UML에 대해 자세히 알아보기

UML은 설계서뿐만 아니라 요구 분석이나 요건 정의에도 사용할 수 있다! 우선 4개만 기억하자!