문서화

1 개요

documentation

文書化

문서화, 다큐멘테이션

• 문서의 형식으로 꾸밈
• 문서의 형식으로 꾸미어 적음
• 어떤 정보를 문서로 나타내는 일
• 일정한 생각, 관념, 사상을 글이나 기호 등으로 나타냄
• 주목적: 빠른 지식 공유

소스코드는 세부사항 모두를 담고 있어 분석에 시간이 많이 걸릴 수 있음

• 전달하고자 하는 정보나 지식 또는 흩어져 있는 자료등을 취합하여 간결하고 규칙적인 배열 형식 의해 종이에 표현하는 방식

2 장점

• 전달하고자 하는 정보의 표현이 정확히 전달됨
• 자료검색시 용이
• 정보전달에 따른 불필요한 시간절약
• 규칙적인 문서형식에 의해 정보전달력 향상
• 정보 손실 방지
• 노하우 축적 가능
• 명확성 증대
• 책임추적 가능

3 예시

• 아키텍처/설계 - 소프트웨어/아키텍처 개요, 설계원칙
• 기술 - 코드, 알고리즘, 인터페이스, API
• 사용자 - 일반사용자 매뉴얼, 관리자용 매뉴얼
• 각종 취급설명서, 고객정보베이스, 메뉴판, 회사내 자료분류등 거의 모든 직군에서의 규칙에 의한 종이자료

4 같이 보기

• 문서
• 스펙
• 산출물
• 명문화
• ISO 690
• 테크니컬 라이팅
• 문서화 웹사이트
• 쿠버네티스 문서화
• 리눅스 문서화 프로젝트(TLDP)

5 참고

• 위키백과 "문서화"
• 영어 위키백과 "Documentation"
• 영어 위키백과 "Software_documentation"
• http://www.isaca.org/Journal/Past-Issues/2012/Volume-4/Pages/Everybody-Loves-Documentation-Korean.aspx