티스토리 뷰

공부/uncategorized

Categorizing

doublemetal 2016. 5. 18. 12:08
verb (used with object)categorized, categorizing.
1.
to arrange in categories or classes; classify.
2.
to describe by labeling or giving a name to; characterize.


팀에서 프로젝트 문서화 도구로 wiki를 사용하고 있다.

단순한 도구이지만, 웹환경에서 프로젝트에 대한 내용에 대해 작성하고 공유할 수 있다.


xmind 같은 마인드맵 도구도 생각을 정리하고 확장하기에 간편하고 강력한 도구지만,

wiki처럼 텍스트 기반의 도구를 더 강력하다고 생각하고 좋아한다.

(이전에는 github에 마크다운 형식으로 프로젝트 문서를 정리한 적도 있다, 문서 제목이 바뀌면 링크가 깨지는 단점이..)


문서를 작성하다보면 한  없이 조잡하고 어지러워지기도 하지만, 몇 가지 원칙을 지키면

보기가 훨씬 좋아진다.


categorizing만 잘한다면, 문서를 보다 깔끔하게 유지할 수 있고 그렇게 된다면, 원하는 문서를

찾기 쉬울 수 있다. (검색기능을 사용하지 않고도)


귀찮고, 정답이 없는 일이라 어렵지만.. 상위 레벨부터 차근차근 정리하다보면, 그 문서만의 규약이

생기고 나중에는 정리하는 일조차 한결 쉬워진다.


여러 컴포넌트에 내용이 묶여 있어 categorizing이 어려운 경우에는 한단계 위로 추상화하고

label 기능을 사용해서 묶는다. (티스토리의 경우에는 tagging) 이런 기능이 없는 플랫폼에서는 문서화가 애매할 수 있다.


끝!

'공부 > uncategorized' 카테고리의 다른 글

Ajax? Ajaj?  (1) 2016.05.18
nodejs  (0) 2016.05.18
Categorizing  (0) 2016.05.18
문서 자동화  (0) 2016.05.18
DSL : Domain-Specific Language  (0) 2016.04.27
[cross domain] window.postMessage  (0) 2015.09.02
댓글
댓글쓰기 폼