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

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

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

참고: 수년 동안 이 온라인 기술 작문 교과서는 보고서를 기술 정보를 포함하는 거의 모든 것이라고 일반적으로 언급했습니다. 그러나 "보고서"는 특정 기술 문서 장르를 의미하기 때문에, "기술 문서"의 약어인 일반적인 "techdoc"으로 변경해야 했습니다.

기술 문서(technical documents의 일반적인 이름)는 다른 종류의 프로젝트와 마찬가지로 사양(specifications)을 갖습니다. 기술 문서의 사양은 레이아웃, 조직 및 내용, 제목과 목록의 형식, 그래픽 디자인 등을 포함합니다. 기술 문서에 대한 요구되는 구조와 형식의 장점은 여러분이나 다른 사람들이 익숙한 방식으로 디자인되어 있을 것이라는 점입니다—무엇을 찾아야 하고 어디서 찾아야 할지를 알고 있습니다. 기술 문서는 보통 급하게 읽히는데—사람들은 필요한 정보, 핵심 사실, 결론, 그리고 기타 필수 사항에 빨리 도달하려고 합니다. 표준 기술 문서 형식은 익숙한 동네와 같습니다.

기술 문서의 디자인을 분석할 때 일부 섹션이 얼마나 반복되는지 주목하세요. 이러한 중복은 사람들이 기술 문서를 읽는 방식과 관련이 있습니다. 그들은 기술 문서를 끝까지 읽지 않습니다: 경영 요약부터 시작하고, 이리저리 넘기며, 아마도 모든 페이지를 읽지 않을 것입니다. 여러분의 도전 과제는 이러한 독자들이 기술 문서의 어느 부분을 얼마나 읽든지 간에, 주요 사실과 결론을 만날 수 있도록 기술 문서를 디자인하는 것입니다.

반드시 봐야 해 예제 기술 문서.

이 장에서는 일반적인 기술 보고서의 표준 구성 요소에 대해 논의합니다. 다음 섹션에서는 각 구성 요소를 안내하고 주요 특징을 강조합니다. 이러한 지침을 읽고 활용하면서, 이것들이 지침이지 명령이 아니라는 점을 기억하세요. 다양한 회사, 직업, 조직마다 자사만의 기술 문서에 대한 다양한 지침이 있으며, 여기 제시된 지침 외에도 그러한 지침에 맞게 여러분의 실무를 조정할 필요가 있습니다.

전달 메시지

전달 메시지는 커버 레터(또는 메모) 또는 이메일입니다. 물리적인 편지(또는 메모)는 스테이플러로 기술 문서의 바깥쪽에 첨부되어 있거나 기술 문서 안에 제본되어 있습니다. 이메일은 기술 문서에 대한 링크 또는 첨부된 기술 문서를 포함합니다. 이것은 여러분—기술 문서 작성자—로부터 수신자에게, 기술 문서를 요청한 사람에게, 그리고 여러분의 전문 상담에 대해 비용을 지불할 수도 있는 사람에게 보내는 의사 소통입니다. 본질적으로 "좋습니다, 여기 우리가 정한 날짜까지 완료하기로 한 기술 문서가 있습니다. 간략히 말하면, 이것과 저것이 포함되어 있지만, 이것이나 저것은 포함되지 않았습니다. 필요에 맞는지 알려주세요."라는 내용을 담고 있습니다. 전달 메시지는 기술 문서가 만들어진 배경—에 대한 설명을 제공합니다. 기술 문서에 포함되지 않아야 할 정보들을 담고 있습니다.

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

전달 서신의 예에서 표준 비즈니스 서신 형식을 주목하세요. 내부 기술 문서를 작성할 경우, 대신 메모 형식을 사용하세요; 어느 쪽이든 내용과 구성은 동일합니다:

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

가운데 문단. 기술 문서의 목적에 초점을 맞추고 기술 문서의 내용에 대한 간략한 개요를 제공합니다.

마지막 단락. 질문, 의견 또는 우려 사항이 있는 경우 독자가 연락하도록 권장합니다. 독자가 기술 문서를 만족스럽게 찾기를 바라는 마음으로 선의의 제스처로 마무리합니다.

기술 문서의 다른 요소들처럼, 특정 상황에 맞게 이 메시지(또는 메모)의 내용을 수정해야 할 수도 있습니다. 예를 들어, 독자들이 기술 문서를 검토할 때 고려하기를 원하는 질문들을 나열하는 또 다른 단락을 추가할 수 있습니다.

커버, 제목 페이지 및 라벨

기술 문서가 10페이지가 넘으면 어떤 방식으로든 제본하고 표지에 레이블을 만드세요.

커버

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

일반적으로 선호되지 않는 것은 링 바인더나 분리형 노트북입니다. 이들은 짧은 기술 문서에는 너무 부피가 크고, 페이지 구멍이 찢어지는 경향이 있습니다. 물론 링 바인더는 페이지 교환을 쉽게 해줍니다; 만약 이렇게 기술 문서가 사용될 예정이라면, 좋은 선택입니다. "고급"의 경우에는 인조 가죽 느낌과 금색 장식이 있는 지나치게 화려한 표지들이 있습니다. 이러한 것들은 피하세요—담백하고 단순하며 기능적인 것이 좋습니다.

제목 페이지

가장 간단하게 말하자면, 기술 문서 제목은 앞 표지에 있는 내용의 복사본으로—몇 가지 세부 사항이 추가될 수 있습니다.

표지 페이지를 확인해 보세요. 초록 및 실행 요약.

라벨들

기술 문서의 표지에 라벨을 반드시 작성하십시오. 이는 일부 기술 문서 작가들이 잊는 단계입니다. 라벨이 없으면 기술 문서는 익명으로 남아 무시당하게 됩니다.

라벨을 만드는 가장 좋은 방법은 워드 프로세싱 소프트웨어를 사용하여 라벨 정보 주위에 그래픽 박스를 넣어 표준 페이지에서 디자인하는 것입니다. 출력한 후 복사 가게에 가서 기술 문서 커버에 직접 복사하도록 하세요.

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


송부 서한 및 기술 문서 표지(표지 라벨 포함).

초록 및 요약

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

임원 요약, 서론 및 전달 메시지가 반복적으로 느껴질 수 있지만, 독자들이 기술 문서를 처음부터 끝까지 페이지별로 읽는 것은 아니라는 점을 기억하세요. 그들은 테이블 오브 컨텐츠를 스캐닝할 수 있고, 일반적으로 임원 요약에서 주요 사실과 결론을 훑어봅니다. 그들은 기술 문서 본문에서 한두 섹션만 주의 깊게 읽고, 나머지는 건너뛸 수 있습니다. 이러한 이유로, 기술 문서는 독자들이 기술 문서의 어느 부분에서든 중요한 정보를 확실히 볼 수 있도록 일부 중복되게 설계됩니다.


목차 (먼저 오는 것) 다음은 요약입니다.

목차

어떤 목차(TOC) 형식을 사용하든, 다음은 일반적인 표준입니다: