개요

목적

"구조화 된보기 쉬운 문서"와
"표현이 일정 수준으로 통일 된 그림 (UML)"
텍스트 파일만으로 작성하고 싶다!

이유

· 텍스트 파일은 (여러가지 의미에서) 가볍다.
・수정의 이력이 관리하기 쉽다

수단

구조화된 보기 쉬운 문서는 "markdown"
표현이 일정 수준으로 통일된 그림(UML)은 "PlantUML"로 기술한다.

운영 환경

Visual Studio Code 위에 Markdown과 PlantUML이 쓸 수 있는 환경을 준비한다.

참고 웹사이트

PlantUML 공식

설치는 이 근처

VS Code로 UML을 그립니다!
VS Code + MarkDown + PlantUML로 개발 문서를 쉽게 이해할 수 있습니다.

더욱 세세하게

PlantUML Cheat Sheet
VSCode 확장의 PlantUML 미리보기가 표시되지 않는 경우의 대응
VSCode에 PlantUML을 도입하는 단계
VS Code에 PlantUML을 도입하여 업무 효율화를 도모한다
Visual Studio Code로 자유롭게 UML을 그리자
Visual Studio Code에서 PlantUML 사용 메모 (Windows) .md
PlantUML 환경 설정
VSCode의 Markdown Preview Enhanced에서 PlantUML이 그려지지 않음

아래 Markdown + PlantUML로 문서 범례

문서 개요

Readme

외부 사양

외부 사양을 설명합니다.

프로토콜

내부 사양

디자인

상태 천이도

상태 전이도는 실제로 Visual Studio Code에서,
PlantUML에 대응한 프리뷰 화면에서 다음과 같이 그려집니다.

시나리오

타겟은?

어떤 상황에서 사용하는가?

어떻게 사용합니까?

제약사항은 무엇인가?

대상외

분명히 오버 스펙입니다

현재 버전에서하지 않는 것

적용되지 않는 플랫폼

용어 해설

일반적인 용어에서도 문서에서 의미를 쓴다

미해결 문제

무엇이 미해결인지 남겨 둔다

이것이 남아있는 동안에는 프로그래머에게 코드를 쓸 수 없다 (기분이 있다)

UML 지침

다음을 구사한다.

상태 전이도

시퀀스 다이어그램

유스 케이스 다이어그램

클래스 (블록) 그림

배치도

타이밍 다이어그램

전반적인 쓰기에 대한 지침

일람성이 중요하다 (화려한 표라면 비교적 보기 쉽다)

전체 그림을 파악한다 (도표에서 간단하게 표현할 수 있는 사양/설계여야 함)

흐름도 (PlantUML의 활동 다이어그램)도 사용됩니다.

다른 사양 및 설계와의 관계를 인식한다

예상되는 모든 상황을 작성하십시오

무엇이 에러가 되는지 모두 쓰기

모든 에러에 대해 어떻게 처리할까 써

왜 그러한 행동에 이르렀는지의 경위와 사고 실험의 경과를 쓴다

간단한 프로그램이 될 수있는 사양/설계가 바람직합니다

테스트 케이스를 쉽게 씻을 수있는 것이 바람직합니다

테스트 가능한 사양/설계 여야합니다

테스트 재현성이 높은 (테스트하기 쉬운) 사양/설계가 바람직하다

소스 코드 읽으면 일목요연한 일은 써서는 안 된다

소스 코드를 빨리 읽을 수있는 가이드가되는 것을 목표로한다