깃헙 readme에 아키텍처를 첨부하려고 합니다.

Question

이번에 블로그 프로젝트를 하나 완성했습니다.깃헙에 프론트단, 백엔드단 이렇게 나눠서 두 개 올리려는데,readme에 아키텍처를 첨부하는게 좋다는 이야기가 많아서요.아키텍처에 관해 찾아서 예시를 보니까, 거대한 틀에서 DNS,로드밸런서,CDN,database 등의 관계를 설명했더라구요.제가 만든게 FE, BE 이렇게 나뉘어 있기는 하지만, 규모가 크지는 않아서 거시적 관점에서 아키텍처를 쓰기에는부담스럽네요.로그인 기능처럼 제가 따로 만든 세부 기능들의 동작을 다이어그램으로 그려서 여러개 올리는 방식을 생각해봤는데,이것도 괜찮을까요?그리고 프로젝트를 완성한 후, 제가 발견한 문제점과 개선방안을 readme에 포함하는것도 괜찮은지 궁금합니다.

개발정복 · Answer

그냥 해보세요 안한것보더 비교할수 없을 정도로 효과가 큽니다

메타인지러 · Answer

아키텍쳐는 적은 그림으로 많이 파악할 수 있는 구조가 좋습니다.특색있는 기능이 아니라면 로그인 기능 등을 세부적으로 표현하는 건 그닥 눈길을 끌 것 같지 않습니다

깃헙 readme에 아키텍처를 첨부하려고 합니다.

2개의 답변

#readme.md 목록