여기를 클릭하여 도와주세요 데이비드 맥머리 웹 호스팅 비용 지불:
기부 가능한 소액을 해주세요!
온라인 기술 작문은 계속 무료로 제공됩니다.

기술 문서(핸드북, 백서 및 가이드를 포함)는 산업, 직업 또는 조직에 따라 다양한 디자인을 가지고 있습니다. 이 장에서는 전통적인 디자인 하나를 보여줍니다. 기술 작성 과정을 수강하고 있다면 이 장에 제시된 디자인이 허용되는지 확인하세요. 과학, 비즈니스 또는 정부 맥락에서 기술 문서를 작성할 때도 마찬가지입니다.

NotebookLM-generated infographic of this chapter 이 장의 NotebookLM 생성 인포그래픽

참고: 수년 동안 이 온라인 기술 작성 교과서는 기술 정보를 포함하는 거의 모든 것을 일반적으로 보고서라고 지칭했습니다. 그러나 "보고서"는 특정 종류의 기술 문서를 의미하므로, 일반적인 "techdoc"으로 변경되어야 했습니다. "techdoc"은 기술 문서의 약자입니다.

기술 문서(techdocs)의 일반적인 명칭은 다른 종류의 프로젝트와 마찬가지로 사양이 있습니다. 기술 문서의 사양은 레이아웃, 구성 및 내용, 제목 및 목록의 형식, 그래픽 디자인 등을 포함합니다. 기술 문서의 필수 구조와 형식의 장점은 당신이나 다른 사람들이 익숙한 방식으로 설계될 것이라고 기대할 수 있다는 것입니다—어디에서 무엇을 찾아야 할지 알 수 있습니다. 기술 문서는 보통 서두르면서 읽히는데—사람들은 필요한 정보, 핵심 사실, 결론 및 다른 필수 요소에 빨리 접근하려고 하기 때문입니다. 표준 기술 문서 형식은 익숙한 이웃과 같습니다.

기술 문서의 디자인을 분석할 때, 일부 섹션이 얼마나 반복적인지 주목하세요. 이러한 중복은 사람들이 기술 문서를 읽는 방식과 관련이 있습니다. 사람들은 기술 문서를 처음부터 끝까지 읽지 않습니다; 보통 경영 요약부터 시작하고, 여기저기 건너뛰며, 아마도 모든 페이지를 읽지 않을 것입니다. 여러분의 도전은 이러한 독자들이 기술 문서의 어떤 부분을 읽거나 어떤 순서로 읽든지 간에 주요 사실과 결론을 접할 수 있도록 기술 문서를 디자인하는 것입니다.

확실히 꼭 보세요 예시 기술 문서.

이 장에서는 전형적인 기술 보고서의 표준 구성 요소에 대해 논의합니다. 다음 섹션에서는 이러한 각 구성 요소를 안내하며 주요 특징을 강조합니다. 이 가이드를 읽고 사용할 때, 이는 지침이지 명령이 아님을 기억하십시오. 다양한 회사, 직업 및 조직은 각기 다른 기술 문서에 대한 지침을 가지고 있으며, 여기서 제시된 지침뿐만 아니라 이러한 지침에도 맞게 실습을 조정해야 합니다.

전송 메시지

전달 메시지는 커버 레터(또는 메모) 또는 이메일 중 하나입니다. 물리적인 편지(또는 메모)는 종이 클립으로 기술 문서의 외부에 붙어있거나 기술 문서 내에 포함되어 있습니다. 이메일에는 기술 문서에 대한 링크 또는 첨부된 기술 문서가 포함되어 있습니다. 이는 기술 문서 작성자인 당신—에서 수신자, 즉 기술 문서를 요청한 사람에게 전달하는 커뮤니케이션입니다. 그 사람은 당신에게 전문가 상담 비용을 지불할 수도 있습니다. 본질적으로, "좋습니다, 여기 우리가 합의한 대로 특정 날짜까지 완료한 기술 문서가 있습니다. 간단히 말해서, 이러이러이 내용을 포함하지만, 저러저러한 내용은 포함되지 않았습니다. 필요에 맞는지 알려주세요."라고 말합니다. 전달 메시지는 기술 문서가 만들어진 배경—을 설명합니다. 기술 문서에 포함되어서는 안 되는 정보도 포함되어 있습니다.

Business letter and email versions of transmital message
전달 서신 및 전달 메시지의 예.

전달 서신의 예에서 표준 비즈니스 서신 형식을 주목하십시오. 내부 기술 문서를 작성할 경우 메모 형식을 사용하십시오; 두 경우 모두 내용과 조직은 동일합니다:

첫 번째 단락. 기술 문서의 이름을 이탤릭체로 작성하세요. 또한 기술 문서를 작성하기로 한 계약 날짜도 언급하세요.

중간 단락. 기술 문서의 목적에 중점을 두고 기술 문서의 내용을 간략하게 개요합니다.

마지막 단락. 질문, 코멘트 또는 우려 사항이 있으면 연락해달라는 독려가 포함되어 있습니다. 독자가 이 기술 문서를 만족스럽게 찾기를 바라는 선의의 제스처로 마무리됩니다.

기술 문서의 다른 요소와 마찬가지로, 특정 상황에 맞게 이 메시지(또는 메모)의 내용을 수정해야 할 수도 있습니다. 예를 들어, 독자가 기술 문서를 검토할 때 고려해 보았으면 하는 질문 목록을 추가하여 다른 단락을 넣고 싶을 수 있습니다.

표지, 제목 페이지 및 레이블

기술 문서가 10페이지를 초과하는 경우, 어떤 방식으로든 제본하고 표지에 라벨을 작성하세요.

커버

커버는 기술 문서에 견고하고 전문적인 외관을 제공하며 보호 역할도 합니다. 다양한 유형의 커버 중에서 선택할 수 있습니다. 다음 팁을 염두에 두세요:

일반적으로 선호되지 않는 것은 링 바인더나 낱장 노트북입니다. These are too bulky for short techdocs, and the page holes tend to tear. 물론, 링 바인더는 페이지를 교체하는 것을 쉽게 만들어 줍니다; 만약 당신의 기술 문서가 그렇게 사용될 것이라면, 좋은 선택입니다. "고급"에서는 가죽 느낌과 금색 장식이 있는 지나치게 화려한 표지가 있습니다. 그것을 피하세요—깔끔하고 간단하며 기능적인 것을 유지하세요.

제목 페이지

가장 간단하게 말하자면, 기술 문서 제목은 표지에 적힌 내용의 복사본입니다—몇 가지 세부 정보가 추가될 수 있습니다.

제목 페이지를 확인하세요. 추상 및 실행 요약.

라벨

기술 문서의 표지를 위한 라벨을 반드시 고안하세요. 이는 일부 기술 문서 작성자들이 잊는 단계입니다. 라벨이 없으면 기술 문서는 익명으로 남아 무시당하게 됩니다.

레이블을 만드는 가장 좋은 방법은 워드 프로세싱 소프트웨어를 사용하여 레이블 정보를 그래픽 박스 안에 디자인하는 것입니다. 인쇄한 후, 복사 가게에 가서 기술 문서 커버에 직접 복사하도록 하세요.

라벨에 들어가는 내용은 많지 않습니다: 기술 문서 제목, 귀하의 이름, 귀하의 조직 이름, 기술 문서 추적 번호, 그리고 날짜입니다. 라벨에 대한 표준 요구 사항은 없지만 귀하의 회사나 조직은 자체 요구 사항을 가져야 합니다. (기술 문서 라벨 예시는 아래에 표시되어 있습니다.)


전달 편지 및 기술 문서 표지 (표지 라벨 포함).

초록 및 요약

대부분의 기술 문서는 최소한 하나의 초록—을 포함하고 있으며, 경우에 따라 두 개의 초록이 있습니다. 이 경우 초록들은 서로 다른 역할을 수행합니다. 초록은 기술 문서의 내용을 요약하지만, 서로 다른 유형은 서로 다른 방식으로 그렇게 합니다:

경영 요약, 소개 및 전송 메시지가 반복적이라고 느껴진다면, 독자들이 기술 문서의 시작부터 끝까지 페이지를 넘기며 읽지 않는다는 점을 기억하세요. 그들은 이리저리 넘겨보며 목차를 스캔할 수 있고, 주요 사실과 결론을 위해 경영 요약을 대충 읽는 경우가 많습니다. 그들은 기술 문서 본문에서 섹션 하나나 두 개만 주의 깊게 읽고 나머지는 건너뛰는 경우도 있습니다. 이러한 이유로 기술 문서는 독자들이 기술 문서의 어느 부분을 읽더라도 중요한 정보를 확실히 볼 수 있도록 일부 중복성이 있도록 설계되었습니다.


목차 (우선순위) 다음은 경영 요약입니다.

목차

사용하는 목차 (TOC) 형식에 관계없이, 이것들은 일반적인 기준입니다: