기술 매뉴얼을 작성하는 것은 단계를 구성하고 명확하고 간결한 문구를 작성하는 직접적인 작업입니다. 기술 매뉴얼의 목적은 최소한의 단계와 가장 명확한 방법으로 작업을 수행하는 방법에 대한 정보를 제공하는 것입니다. 기술 매뉴얼에는 종종 주제 전문가, 편집자 및 기술 저자를 포함한 많은 사람들의 협력이 필요합니다. 기술 매뉴얼 역시 지속적으로 개정되고 업데이트 될 수 있으므로 관련 당사자 간의 의사 소통은 매뉴얼 개발에 중요합니다.
단순화 된 스타일 가이드를 만들거나 기술 설명서 용 Microsoft 스타일 가이드와 같은 기존 스타일 가이드를 따라 기술 설명서의 스타일을 결정하십시오. 스타일 가이드는 설명서의 골자를 만들고 일관성을 유지하는 데 도움이됩니다.
동사로 시작하는 프로 시저에 대한 단계를 작성하십시오. 단계를 작성하기 위해 협의가 필요하면 면담하고 주제 전문가의 질문을하십시오. 이것은 절차의 유효성을 보장 할 것입니다; 그렇지 않으면, 단계가 논리적이거나 순서가 맞지 않을 수 있습니다. 단계를 논리적으로 정렬하고 논리적 장 또는 부서로 분리해야합니다.
그래픽 및 일러스트레이션을 필요로하는 단계에 추가하십시오. 각 그래픽 / 그림에 그림 번호와 제목을 추가하십시오.
쉽게 참조 할 수있는 목차와 색인을 만듭니다.
각 변경 사항을 기록하고 향후 개정 및 릴리스를 위해 설명서로 업데이트하는 변경 로그 또는 업데이트 시트를 추가하십시오. 기술 매뉴얼은 항상 전문 작가가 편집해야하며, 전문 편집인이 편집하는 것이 좋습니다.
