Blog
기술 문서에는 여러 유형이 너무 많아 여기에 모두 나열하는 것이 거의 불가능합니다.
기술 작가로 오랜 경력을 쌓은 동안 저는 개인적으로 프로젝트마다 다른 15 가지 유형의 기술 문서를 작성 했어야합니다.
가장 추상적 인 수준에서 기술 문서는 내부 사용자 및 외부 최종 사용자 용으로 분류됩니다.
예를 들어 시스템 구성 가이드 는 “내부”문서의 예이고 설치 가이드 는 외부 최종 사용자문서의 예입니다.
API 가이드 는 모두 내부 용일 수 있습니다. 및 외부 사용자. 반면 빠른 시작 가이드 는 거의 항상 외부 최종 사용자를 대상으로합니다.
사용자 가이드 , 문제 해결 가이드 , 참조 시트 , 릴리스 노트 , (편집 됨) 마케팅 요구 사항 문서 (MRD), 아키텍처 및 엔지니어링 문서 (A & E 문서), 도움말 파일 , 표준 운영 절차 (SOP) 매뉴얼 등
를 방문해 주셔서 감사합니다. a> 이러한 모든 유형의 기술 문서에 대한 무료 정보를 제공합니다.
존재하는 기술 문서 유형을 분류하는 다양한 방법이 있습니다. 모든 것을 아는 척하지는 않지만 기술 문서를 분류하는 데 사용할 수있는 두 가지 주요 범주는 사용자와 사용 사례입니다.
“사용자”란 무엇을 의미합니다. 사용자 유형이 문서를 사용합니까? 관리자 안내서입니까, 튜토리얼입니까, 사용자 안내서입니까? 문서를 디자인 할 때 이러한 수준의 지식을 고려합니다. 관리자 가이드는 문서를 읽는 사람이 가이드를 읽는 사람보다 조금 더 알고 있다고 가정합니다.
“사용 사례”란 문서의 용도를 의미합니까? 여기에는 미사일 발사 방법에 대한 군사 문서에서 그래픽 API를 사용하여 비디오 게임을 개발하는 방법에 대한 개발자 문서에 이르기까지 다양합니다.
질문 범위를 좁힐 수 있다면 제가 할 수있을 것입니다. 원하는 정보를 더 많이 제공합니다.