기술 문서 작성 방법 개요. 우연히 작성된 문서는 우연히 생성되지 않습니다. 보고서, 매뉴얼 또는 기타 기술 문서에 포함 된 자료는 계획, 정리 및 작성됩니다. 문서의 개요 단계는 중요한 단계이며 개요가 작성되지 않으면 정보가 논리적으로 표시되지 않을 가능성이 있습니다. 윤곽을 그리는 것은 저자에게 포함시켜야하거나 포함해서는 안되는 정보에 대해 생각할 기회를 제공합니다.
아이디어를 브레인 스토밍하십시오. 개요에 기술 문서에 포함되어야한다고 생각되는 아이디어를 적어 두십시오. 정보의 순서에 신경 쓰지 마십시오. 모든 정보가 브레인 스토밍 프로세스에 포함되는 것이 중요합니다.
기술 문서의 목적을 결정하십시오. 문서를 읽을 사람, 읽는 이유, 사용 방법 등 자신에게 질문하십시오.
역사적, 연대순, 일반에 특정한 것, 작은 것에서 큰 것, 단순한 것에서부터 복잡한 것까지 또는 콘텐츠에 적합한 다른 형태로 작성하려는 윤곽 유형을 결정하십시오. 청중과 당신이 제시하고자하는 정보에 대해 생각해보십시오. 정보가 정렬되는 방식이 제시되는 정보 유형과 기술 문서를 읽을 청중에게 가장 합당한 지 확인하십시오.
적절한 순서로 정보를 정렬하십시오. 개요에는 정보를 논리적 섹션과 레벨로 그룹화하는 것이 포함됩니다. 기본 주제 및 하위 주제와 하위 주제를 작성할 수 있습니다.
정보를 검토하여 주제가 적절하고 논리적으로 구성되어 있는지 확인하십시오. 핵심 사실을 놓치지 않았는지 확인하십시오. 기술 문서와 관련이없는 정보를 삭제하십시오.
