도리안의 개발 잡설 #434 - 조금씩 문서화 진행

dorian-dev (70)in zzan • 2 years ago

개발 하면서 공유 받은 기획 문서, 디자인, 그 외 문서나 자료 관련 페이지들은 브라우저의 즐겨찾기에 등록하곤 했다. 그런데 페이지의 개수가 많아지면서 이들을 모두 즐겨찾기에 추가하는 것은 좋은 방법이 아니라는 생각이 들었다. 그렇다면 대안이 무엇일까... 내가 찾은 대안은 각 프로젝트의 readme를 이용하는 것이다. GitHub나 GitLab에 등록된 프로젝트 저장소에 readme.md 파일을 추가할 수 있고, 마크다운 포맷을 이용하여 간단한 문서를 작성할 수 있다. 거기에 프로젝트에 대한 간단한 소개와 각종 자료 링크들을 올리는 것이다. 그러면 각 프로젝트 페이지만 즐겨찾기로 등록하면 된다.

이제 기존 프로젝트들을 대상으로 readme.md 파일들을 작성하고 있다. 그리고 즐겨찾기에 등록된 페이지들도 일부만 남기고 삭제할 것이다. 다음 업무를 진행하기 위해서는 정리가 필요하다. 한바탕 정리하고 나면, 지금의 혼란스러움이 어느 정도 해결될 수 있을 것이다.