Two Scoops of Django - #23장

이번장은 문서화에 대한 내용이다.

reStructuredText나 스핑크스 같은 도구를 사용하면 한결 더 편하게 프로젝트를 문서화 가능

 

1. 파이썬 문서에 reStructuredText 이용하기 : 파이썬 표준에 맞는 문서화 방법을 익히고 따를 것.

 

2. reStructuredText로부터 스핑크스를 이용하여 문서 생성 : 스핑크스는 .rst 파일을 보기 좋게 꾸며진 문서로 변환해주는 도구임.

 

3. 어떤 문서를 작성해야 하는가 : 개발문서는 개발자들이 프로젝트를 셋업하고 관리하는 데 필요한 설명과 가이드라인을 의미. 여기에는 설치, 개발, 아키텍처 노트, 테스트 케이스를 실행하는 방법, 코드의 풀 요청을 제출하는 방법 등이 포함됨. 

 

4. 문서화에 대한 여러 자료들을 링크로 제공한다

 

5. 마크다운 : reStructuredText와 크게 다르지 않은 텍스트 포맷 문서. 나는 마크다운은 써봄. 요즘은 거의 md로 쓰지 않나.. 그래서 그런지 README.md를 README.rst로 변환하는 방법도 소개한다.

 

오늘은 매우 짧은 내용이었다. 문서화는 중요하지만.. 역시나 딱히 필요한 경우(퇴사로 인한 인수인계)가 아닌 경우 잘 안하게 되는 거 같긴 하다. ㅎㅎ