본문 바로가기

개발관련

개발 문서, 어떻게 작성하는게 좋을까?



나는 나름 꼼꼼이라면 한 꼼꼼한다고 자부한다.

정리도 나름 잘한다고 생각한다.


언제나 프로젝트를 진행할때는 깃허브의 위키에 개요나 내용을 적어두고 시작하고 했었다.


문제는 엄청나게 안정화된 프로젝트가 아니라면 수정해야할 사항이 넘처난다는 것이다.

때로는 기존에 작성된 내용을 통체로 갈아 엎어야 할때도 많다. ㅜㅜㅜㅜ


그래서 이제는 위키를 버리고 이슈를 사용중이다.

이슈를 이용해서 변경사항의 히스토리를 기록하는 것이다.




개발이라는 것은, 결국 프로젝트의 실시간 진화(?)에 가깝다.

멈춰있는 프로젝트란 존재하지 않는다. 점점 쓸모없어질 것이니까 말이다.


중요한점은 히스토리화 하고, 나중에 잘 찾을 수 있어야 한다는 것이다.

그런점에서 깃허브는 빗버킷보다는 '보기가 편하다' 개인적으로.



고정된 문서인 위키 > 이슈로 이동하는게 바람직하다는 생각이 든다



ps. 갑자기 깃허브 찬양?