최근 회사에서 생산하는 설비에 들어가는 소프트웨어를 문서화 하라는 지시를 받았습니다.
저는 문과 출신에 코딩을 해 본 적은 없고,
컴공 출신 직원을 통해 문서화를 시도 중입니다.
구글링을 한참 해 봐도 도대체 저희가 해야 하는 문서화의 형태가 잡히지를 않네요.
아질게에도 사실 큰 기대 없이 글을 올려봅니다.
간단한 배경정보는 다음과 같습니다.
- 자사 설비에 설치되는 프로그램의 문서화 필요
- 개발 예정 소프트웨어가 아닌 기 개발된 소프트웨어의 문서화 우선
- 소프트웨어 개발자가 바뀌더라도 문서화 자료를 보고 소프트웨어의 구조와 의미를 이해할 수 있는 문서가 필요
- 주석 및 소스코드를 분석하여 역으로 소스코드의 구조 및 기능 등에 대한 설명을 해야 함
대략 이런 상황인데
참고가 될만한 사이트나 서식이라는 게 있을까요???
doxygen 을 사용해서 문서를 만들어 보시는거를 추천 드립니다.
굳이 만들어야 한다면 표와 UML 다이어그램을 최대한 활용해 그럴듯하게 꾸미는게 좋을 것 같습니다.
SW 문서화 관련책을 보면 간단한 예시가 있습니다. 참고하면 될듯 싶습니다.
http://www.graphviz.org/download/
개발자가 아니고서는 전체적인 구조를 이해해서 문서를 작성하기는 힘들것 같습니다.
(자기가 한것도 나중에 몰아서 하려면 쉽지 않습니다.)
그나마 Graphviz를 사용하면 구조를 이해하는데 도움이 될것 같습니다.