문서화

TIL 을 기록하든 블로그글을 기록하든 좋은 문서화에 대해서 고민을 해보자.

1. 가장 좋은 문서화는 코드이다.

적혀있는 코드만 보면 개념을 이해할수 있는 코드가 가장 좋은 문서이다.아무리 설명을 많이 달더라도 공식문서나 책만큼 많이 담을 수는 없다. 링크를 걸어놓고 최대한 미래에 내가 보았을때 간결히 써보자.

2. 코드로 표현할수 없는 부분을 글과 그림등으로 나타낸다.

예) 여러 DB들중 이러한 DB를 사용하는 이유, 비즈니스 로직, 아키텍쳐 부분 등.

출처

드림코딩엘리

중 문서화 부분