문서화

[섬네일|1975년 운영 체제 [CB UNIX와 관한 여러 권의 프로그래머용 설명서.]]
**문서화**(文書化) 또는 **도큐멘테이션**()은 부품, 조립, 설치, 유지보수 및 사용과 같은 대상, 시스템 또는 절차의 일부 속성을 기술, 설명 또는 지시하는 데 사용되는 전달 가능한 모든 자료를 말한다. 지식 경영 및 지식 조직화의 한 형태로서, 문서화는 종이, 온라인, 또는 오디오 테이프나 CD와 같은 디지털 미디어 또는 아날로그 매체로 제공될 수 있다. 이러한 자원의 예로는 사용 설명서, 백서, 온라인 도움말, 그리고 빠른 참조 가이드 등이 있다. 종이 형태의 하드카피 문서는 덜 일반적이게 되었다. 현대의 문서화는 종종 웹사이트, 소프트웨어 제품 및 기타 온라인 애플리케이션을 통해 배포된다.

교육 자료의 집합으로 이해되는 문서화는 정보의 기록 및 검색을 연구하는 학문인 문서학과 구별된다.

## 문서 생성의 원칙

관련된 국제 표준화 기구(ISO) 표준을 공개적으로 쉽게 구하기는 어렵지만, 이 주제에 대한 다른 소스의 가이드가 그 목적을 대신할 수 있다.

문서화 개발에는 문서 초안 작성, 서식 지정, 제출, 검토, 승인, 배포, 재게시 및 추적 등이 포함될 수 있으며, 규제 산업에서는 관련된 표준 작업 절차에 의해 소집된다. 또한 처음부터 콘텐츠를 만드는 과정이 포함될 수도 있다. 문서는 읽기 쉽고 이해하기 쉬워야 한다. 너무 길고 장황하면 오해를 받거나 무시될 수 있다. 명확하고 간결한 단어를 사용해야 하며, 문장은 최대 15 단어로 제한해야 한다. 일반 대중을 대상으로 하는 문서는 성별 특정 용어나 문화적 편견을 피해야 한다. 일련의 절차에서 단계는 명확하게 번호를 매겨야 한다.

## 문서 제작
기술 작가(Technical writers)와 기업 소통 전문가는 문서화가 그들의 분야이자 업무인 전문가들이다. 이상적으로 기술 작가는 주제와 글쓰기, 콘텐츠 관리 및 정보 아키텍처에 대한 배경지식을 모두 갖추고 있다. 기술 작가는 일반적으로 엔지니어, 기술 전문가, 의료 전문가 등과 같은 주제 전문가와 협력하여 사용자의 요구를 충족하는 문서를 정의하고 작성한다. 기업 소통에는 다음과 같은 다른 유형의 서면 문서화가 포함된다:
* 마케팅 커뮤니케이션(MarCom): MarCom 작가는 인쇄물, 전자 매체 및 소셜 미디어를 통해 회사의 가치 제안을 전달하기 위해 노력한다. 기업 글쓰기의 이 영역은 종종 제안서 응답에 관여한다.
* 기술 소통(TechCom): 기술 작가는 회사의 제품이나 서비스를 문서화한다. 기술 간행물에는 사용 설명서, 설치 및 구성 매뉴얼, 문제 해결 및 수리 절차가 포함될 수 있다.
* 법률 작성: 이러한 유형의 문서는 종종 변호사나 법률 보조원에 의해 준비된다.
* 규정 준수 문서화: 이러한 유형의 문서는 안전 승인, 세무, 금융 및 기술 승인과 같은 모든 규제 준수 요구 사항을 위한 표준 작업 절차를 성문화한다.
* 의료 문서화: 이 문서화 분야는 의료 서비스를 제공하는 과정에서 발생한 사건의 시기적절한 기록과 검증을 포괄한다.

## 컴퓨터 과학에서의 문서화

### 유형
다음은 전형적인 소프트웨어 문서화 유형이다:
* 제안요청서
* 요구사항/작업 명세서/작업 범위
* 소프트웨어 설계 및 기능 명세서
* 시스템 설계 및 기능 명세서
* 변화관리, 에러 및 개선 추적
* 사용자 수용 테스트(User Acceptance Testing)
* Man page

다음은 전형적인 하드웨어 및 서비스 문서화 유형이다:
* 컴퓨터 네트워크 다이어그램
* 네트워크 맵
* IT 시스템용 데이터시트 (예: 서버, 개폐기)
* 서비스 카탈로그 및 서비스 포트폴리오(정보기술 인프라 라이브러리)

### 소프트웨어 문서 폴더 (SDF) 도구
시뮬레이션 산업에서 작성되는 **일반적인 유형**의 소프트웨어 문서는 SDF이다. 임베디드 항공 전자 장치부터 전체 모션 제어 시스템을 통한 3D 지형 데이터베이스에 이르기까지 시뮬레이터용 소프트웨어를 개발할 때, 엔지니어는 프로젝트 또는 모듈의 개발 "빌드"를 상세히 기록하는 노트를 작성한다. 이 문서는 위키 페이지, 마이크로소프트 워드 문서 또는 기타 환경일 수 있다. 여기에는 소프트웨어의 통신 인터페이스를 상세히 설명하는 인터페이스 섹션과 요구사항 섹션이 포함되어야 한다. 종종 개념 증명을 상세히 기술하고 에러와 개선 사항을 추적하기 위해 노트 섹션이 사용된다. 마지막으로 소프트웨어가 어떻게 테스트되었는지 기록하는 테스트 섹션이 있다. 이는 고객의 요구사항에 대한 적합성을 문서화한다. 결과적으로 소프트웨어가 어떻게 설계되었는지, 대상 장치에 소프트웨어를 빌드하고 설치하는 방법, 알려진 결함 및 워크아운드에 대한 상세한 설명이 만들어진다. 이 빌드 문서를 통해 미래의 개발자와 유지보수 담당자는 적시에 소프트웨어를 파악할 수 있으며, 코드를 수정하거나 버그를 찾는 로드맵을 제공받을 수 있다.

### 네트워크 인벤토리 및 구성을 위한 소프트웨어 도구
이러한 소프트웨어 도구는 네트워크 장비의 데이터를 자동으로 수집할 수 있다. 데이터는 인벤토리 및 구성 정보가 될 수 있다. 정보기술 인프라 라이브러리는 IT 책임자를 위한 모든 정보의 기초로서 이러한 데이터베이스를 생성할 것을 요구한다. 이는 또한 IT 문서화의 기초가 된다. 예로는 XIA Configuration이 있다.

## 형사 사법에서의 문서화

"문서화"는 범죄 데이터베이스를 채우는 과정에 선호되는 용어이다. 예로는 국가 대테러 센터의 테러리스트 정체성 데이터마트 환경, 성범죄자 등록부, 조직 폭력배 데이터베이스 등이 있다.

## 유아 교육에서의 문서화

유아 교육 분야와 관련된 문서화는 "우리가 세상에 대한 아이들의 아이디어, 생각, 질문, 이론을 알아차리고 가치를 부여한 다음, 그들의 작업 흔적(그림, 활동 중인 아이들의 사진, 그들의 말을 기록한 대본)을 수집하여 더 넓은 공동체와 공유하는 것"이다. 따라서 문서화는 교육자가 아이들에 대해 알고 배운 내용을 가족, 다른 협력자, 심지어 아이들 자신과 연결하는 데 사용되는 과정이다. 문서화는 관찰, 성찰, 기록, 공유 및 응답으로 이어지는 탐구 주기의 필수적인 부분이다. 교사 문서화 측면에서 교육적 문서화는 "아이들의 이해가 변화하는 움직임에 대한 교사의 이야기"이다. "문서화 - 우리의 관점 변화시키기"에서 스테파니 콕스 수아레즈(Stephanie Cox Suarez)에 따르면, "교사는 연구자로 간주되며, 문서화는 어린이와 성인 사이의 지식 구축을 지원하는 연구 도구"이다.

문서화는 교실에서 여러 가지 다양한 스타일을 취할 수 있다. 다음은 문서화가 연구 또는 학습을 가시화할 수 있는 방법의 예시이다:

# 문서화 패널 (프로젝트나 이벤트에 대한 여러 사진과 설명이 포함된 게시판 형태의 프레젠테이션).
# 일일 기록 (교실에서의 놀이와 학습을 매일 기록하는 로그)
# 아이들에 의해 또는 아이들과 함께 개발된 문서화 (문서화 중에 아이들을 관찰할 때, 실제 문서화에 아이의 관찰 렌즈가 사용됨)
# 개별 포트폴리오 (각 아이의 발달을 추적하고 강조하는 데 사용되는 문서화)
# 전자 문서화 (가족 및 협력자와 문서화를 공유하기 위해 앱과 장치를 사용함)
# 대화의 대본 또는 녹음 (문서화에 녹음을 사용하면 교육자와 아이 모두에게 더 깊은 성찰을 불러일으킬 수 있음)
# 학습 이야기 ("학습을 묘사하고 아이들이 스스로를 강력한 학습자로 인식하도록 돕는" 내러티브)
# 문서화로서의 교실 (교실의 물리적 환경에 대한 성찰과 기록).

문서화는 분명히 그 자체로 하나의 과정이며, 교육자 내부에서의 과정이기도 하다. 다음은 교육자 자신에게 진행되는 문서화의 발전 단계이다:

* 문서화 습관을 기른다
* 활동을 이야기하며 대중 앞에 나서는 것에 편안함을 느낀다
* 시각적 리터러시 기술을 개발한다
* 학습 스타일을 가시화하는 것으로서 문서화의 목적을 개념화한다
* 해석 목적 및 향후 커리큘럼 설계를 위해 가시적인 이론을 공유한다.

## 같이 보기
* 리눅스 문서화 프로젝트
* 문서

## 각주

## 외부 링크
*  Documentation Definition by The Linux Information Project (LINFO)
* Library of articles on documentation: Technical writing and documentation articles 

분류:기술 소통
분류:정보과학