1단계: 계획하기

기술문서의 작성 전에 반드시 특정 독자를 분석해야 합니다. 특정 독자를 구분하자면, 일차적 독자, 즉 기술 문서를 직접 사용하는 사람이 되겠고 이차적 독자와 같은 기술문서를 참고하는 사람이 있습니다. 이차적 독자는 프로젝트에 직접 참여하지는 않지만, 간접적으로 관련이 있는 사람입니다. 특정 독자의 분석 항목은 해당 기술 지식의 수준과 그들의 직급, 그리고 주요 관심 항목이 있습니다. 특정 독자를 분석하는 방법은 타사의 기술 문서의 작성 수준을 조사하여 그들의 이해 수준을 파악하는 방법과 해당 기술 지식의 수준에 대한 설문조사를 통하여 파악하는 방법이 있습니다. 

특정 독자를 분석하는 1단계는 계획하기입니다. 특정 독자의 기술 지식 수준별 기술문서 작성의 방법은 기술적 지식수준이 높은 특정 독자를 타깃으로 한다고 했을 때는  용어의 정의와 고급 기능을 구현할 수 있는 방법과 예제를 작성하면 됩니다. 이에 반해 만약 기술 지식 수준이 낮은 독자는 용어의 정의, 해당 기술에 대한 자세한 개념과 상세하고 많은 예제를 꼼꼼하게 작성해야 합니다. 독자에 따라서 문구의 뉘앙스와 기술문서의 레벨이 확연히 달라지므로 독자를 분석하는 것은 아주 중요한 첫 번째 단추 맞추기라고 볼 수 있습니다. 그렇다면 기술적 지식수준이 높은 독자와 기술적 지식수준이 낮은 독자를 동시에 만족하게 하려면 어떻게 해야 할까요? 두 개의 문서를 분류하여 연결하는 방법이 있을 수 있습니다. 예를 들면, 초급 독자에게는 Tutorial과 같이 상세하게 설명해 주는 방식의 문서로 접근한다면, 고급 독자에게는 Advanced User Manual과 같이 고급 단어와 고급 기술에 대한 내용을 작성하는 것입니다. 또 다른 방법으로는 구성으로 분류하는 것이 있습니다. 개념과 동작 위주 그리고 참고할 만한 내용으로 분류하는 것 니다. 이렇게 구분하면  독자 입장에서 필요한 부분만 참고할 수 있습니다. 예를 들면 기술적 지식수준이 높은 독자는 개념 부분은 필요하지 않으므로 동작 위주나 Advanced 된 내용이 포함된 Reference 자료를 참조할 것입니다. 

1단계인 계획에서는 기술 문서 작성의 목적 또한 분명히 해야 합니다. 독자를 분석하였으면 문서의 목적을 분석합니다. 내가 작성한 기술문서를 가지고 특정 독자가 무엇을 할 것인지 분석을 합니다. 예를 들면 "시스템을 만들기 위해서 기술 문서가 필요할까?"부터 시작합니다. 필요하다면 시스템을 유지 보수하기 위해 기술문서가 필요한 것 인가도 자문해 볼 수 있습니다. 또한 시스템의 신뢰성 테스트 결과를 보고하기 위해서 기술 문서가 필요한지도 분석할 수 있습니다. 이렇게 기술문서의 목적을 분명히 분석하였으면, 이 작성 목적에 따라서 기술 문서의 타입과 내용의 작성 방법이 달라집니다. 고객사 엔지니어가 시스템을 정확하고 빠르게 개발하기 위해 기술문서가 필요한 것이라면 데이터 시트 또는 소프트웨어 개발 키트, 프로그래밍 가이드 등을 위주로 문서를 개발할 수 있습니다. 만일 고객사의 엔지니어가 시스템을 정확하고 빠르게 사용하기 위해 기술 문서가 필요한 것이라면 사용자 매뉴얼 관리자 매뉴얼 등의 문서 형태가 적합합니다. 고객사의 엔지니어가 시스템의 문제점을 빠르게 해결하기 위한 기술 문서가 필요한 것이라면 문제 해결 가이드가 문서의 형태가 될 것입니다. 시스템의 신뢰성 테스트의 결과를 명확히 이해하기 위해 기술 문서가 필요한 것이라면 신뢰성 테스트 보고서가 문서의 형태가 됩니다.

1단계의 다음 순서는 기술문서의 타입과 릴리즈 방식을 선택합니다. 내가 작성한 기술 문서를 가지고 특정 독자가 무엇을 할 것인지 분석을 합니다. 시스템에 예를 들면 보안 감시카메라와 자동차용 블랙박스를 만들기 위해 기술 문서가 필요한 것인지, 유지보수를 위한 것인지 테스트 결과를 보고하기 위한 것인지 등을 분석하기도 합니다. 기술문서의 작성 목적에 따라 기술 문서 타입과 내용의 작성 방법이 달라지는데, 기술문서의 타입으로는 사용자 매뉴얼, 소프트웨어 개발 키트 문서, 퀵스타트 가이드, 라이브러리 설명서, 프로그래밍 가이드, 애플리케이션 노트, 설계서, 분석서, 신뢰성 테스트 결과 보고서 등이 있습니다. 릴리즈 방식은 PDF가 대부분의 형식이지만, 때로는 Chm 파일과 Web help 파일의 형식이 있습니다.