매뉴얼, 문서, 주석

철학 2006. 7. 20. 07:22
문서(매뉴얼), 주석없는 코드는 아무런 쓸데 없는 코드이다.
이 두가지가 없으면, 결국은 다시 때려 부수는 일을 하게 마련인 것이다.
혼자서 하게 되면, 이런 것이 필요없으나, 여러 사람들이 공동으로 할 때에는 주석말고, 반드시 문서로 쉽게 매뉴얼로 작성해야 한다. 이는 Macro적 시야는 문서에서, Micro적 시야에서는 주석에서 알 수 있기 때문이다.

적절한 프로세스를 기반으로 가이드라인을 제시하고, 상식적인 혹은 확인할 수 있는 범위내에서, 구성원들이 따라야 할 규칙과 표준을 지키도록 해야 한다.
특히, 코딩 컨벤션, 백업 같은 경우는 반드시 지켜야 한다. 중요한 철학등은 문서화하여 반드시 공유할 수 있도록 해야 한다.

'철학' 카테고리의 다른 글

개발자와 QA엔지니어와의 협력  (0) 2006.07.20
소프트웨어 공학 - 사람 키우기  (0) 2006.07.20
Do it right things.  (0) 2006.07.20
실수하지 않기  (0) 2006.07.20
데모관련 지원에서 마무리작업  (0) 2006.07.20
Posted by '김용환'

댓글을 달아 주세요