문서화 3가지
1. 코드 자체의 문서화
- 굳이 문서를 따로 적지 않았어도 코드 자체가 문서이야 한다.
- 코드는 문서화를 하지 않는 것이 정석이다. 문서화를 해야되는 순간 내가 코드를 못짜고 있는지 의심하자.
- 단, 어떤 경우에 (최적화, 특성 등) 코드 만으로 이해가 어려울 수 있는 경우 문서화를 할 수 있다.
- 코드 변수명은 중요.
2. 프로세스 문서화 3:25
- 프로세스 문서화 : 프로세스 실행 방법을 자세히 설명하는 문서 (ex. 데이터베이스를 업데이트를 할 때 이런이런 절차에 따라 무엇을 해야한다. 휴가를 달라고할 때는 이런 절차에 따라야한다.)
- 프로세스는 작은 것 이라도 아주 간단한게 적어두는 것이 좋다. 다른 사람들이 볼 수도 있고 본인이 까먹을 수도 있고, 구글 드라이브를 이용하면 검색이 가능하기 때문이다.
3. 라이브러리, API 문서화 6:45
- 만들고 있는 라이브러리의 API가 바이너리로 만들어서 누군가 include 해서 쓰든 웹 API로 만들어서 누군가 api 를 호출해서 쓰든 어느쪽이든 함수의 이름과 입력값 그리고 반환값을 설명이 필요할 때가 있다.
- API Document를 만든다. 자동으로 만들어주는 문서화 Swagger 을 사용할 수 있다.
4. 기타
- 문서 상단이나 하단에 추가 내용으로 “만약, 문서에서 틀린 부분을 찾으면 너가 알아서 찾아서 고칠 것” 이라는 내용을 적는다.
- 간단하게 1, 2, 3, 4 번 순서대로 따라하여 따라할 수 있도록 만든다.