요 전날 공공 분들도 대응 한 것 같습니다.

출시 노트 - Qiita

이것을 한 경위

지금까지 경험해 온 프로젝트에서도 많은 시스템 구성도를 작성해 왔습니다만, ER도라든지 사양서라든지 구성도도 포함해,
문서는 역시 최신의 상태로 관리되지 않는구나 - 라고 하는 것을 상당히, 과제에 느끼고 있어, 잠시 어떻게 하면 좋을까
라고 생각을 돌렸습니다만, 시스템 구성도에 관해서는 이렇게 하는 것은 어떨까 이라고 하는 나 이외의 우수한 엔지니어의 여러분에게의 문제 제기가 됩니다.

지금까지는 무엇이 문제였습니까?

그림을 그리기 쉬운 툴(Cacoo라든가)을 사용해 구성도를 작성하고 있어, 개발하는 소스나 사용하고 있는 툴과는 떨어진 장소에서 관리되는 상태였다

개발 프로젝트에 참가했을 때에 최소한 필요한 것(소스나 미들웨어, 태스크 관리 툴 등) 안에 없기 때문에 중간에 들어간 사람에게는 공유되지 않을 수도 있었다

별로 이것이 없어도 솔직히 아무것도 문제없는 사람도 있으므로, 만들어도 그 이후의 수정은 되지 않는(버전 관리되지 않는) 상태였다.

어떻게 하면 좋을까?

개발하고 있는 소스와 함께 Git 관리되는 편이 좋은 것은

Github등에서 소스 제어하고 있다면 이제, Readme.md라든지로 시스템 구성도 확인할 수 있는 상태로 해 버리는 것이 좋을 것 같다

그렇게 되면, Readme.md가 Markdown인 것도 있고, 향후의 버전 관리로 변경하기 쉬운 상태로 하는 것도 생각하면, Markdown같은 것이 좋다

음, 텍스트로 그림을 쓸 수 있는 것은 뭔가 없었던 것

PlantUML이 있습니까?

그렇다고 해서, 여러가지 조사해 보았다.
다음은 Qiita로 하는 것으로 한층 더 조사해 보았는데, 응용으로 할 수 있을 것 같았기 때문에, Qiita로 PlantUML인 시스템의 구성도를 써 보았습니다.

참고한 기사

간단한 텍스트 파일로 UML을 작성할 수 있는 오픈 소스 도구

PlantUML로 코드베이스로 AWS 아키텍처 다이어그램을 만드는 방법 - Qiita

awslabs/aws-icons-for-plantuml: PlantUML sprites, macros, and other includes for Amazon Web Services services and resources

Qiita에 UML을 올릴 수 있도록 PlantUML을 사용하여 웹 서비스를 만들려고 생각하면 본가에 있었던 이야기 - Qiita

완성 된 것이 여기

AWS로 구성된 한 시스템의 개발 환경을 PlantUML화해 보았습니다
이 이미지의 URL을 그대로 이 사이트 으로 입력하고 Submit 하면, 원래의 PlantUML 내용도 확인할 수 있습니다

요약 시스템 구성도 제대로 버전 관리한다면 PlantUML로 관리하면 잘 관리될 가능성이 높아질지도

Github의 Readme.md에서 확인할 수 있으면 좋지만, PlantUML의 공식 사이트?이 살아야 할 것 같습니다 104

같은 흐름으로 ER도나 유스 케이스도라든지 대응은 할 수 있을 것 같다- 라고 느꼈습니다만, 과연 어디까지 제대로 관리할 수 있을까