여기를 클릭하여 도와주세요. 데이비드 맥머리 웹 호스팅 비용 지불:
작은 금액이라도 기부해 주세요!
온라인 기술 글쓰기는 계속 무료로 제공됩니다.
당신이 설명을 작성할 때 가장 큰 장애물은 이 맥락에서 그 용어가 의미하는 바를 기억하는 것입니다. 우리는 모두 그 단어를 사용합니다. 설명 실질적으로 어떠한 논의나 설명을 가리키기 위해 느슨하게 사용됩니다. 그러나 이 맥락에서는 의미합니다. 사물의 물리적 측면에 대한 상세한 논의. 이것은 색상, 모양, 크기, 무게, 높이, 너비, 두께, 질감, 밀도, 내용물, 구성 재료 등을 논의하는 것을 의미합니다.
예를 들어, 이 문장은 우리 말의 의미에서 진정한 설명이 아닙니다:
컴퓨터 디스켓은 전자 데이터를 저장하는 데 사용되는 장치입니다.
기능이나 목적을 설명하지만 물리적인 세부사항은 거의 제공하지 않습니다. 그러나 이 문장은 매우 분명히 설명입니다:
1980년대의 일반적인 컴퓨터 디스켓은 3.5인치 x 3.5인치이며 약 1/8인치 두께였습니다.
꼭 확인해 보세요. 예제 설명들 이 장에서 제공됩니다.
이 장의 NotebookLM 생성 인포그래픽
설명을 위한 맥락
앞서 언급했듯이, 설명은 기술 문서에서 일반적인 요소입니다 — 하지만 지침과는 약간 다른 방식으로 나타납니다. 설명은 여기서 한두 문장, 저기서 한 단락, 또는 다른 곳에서는 전체 섹션으로 더 자주 나타납니다. 특정 종류의 기술 문서는 설명을 특징으로 합니다:
- 사고 보고서에는 많은 설명이 필요합니다.
- 제품 사양—문서에는 새롭게 변경된 제품의 디자인과 특징에 대한 설명이 많이 포함되어 있습니다—.
- 지침은 종종 독자가 자신이 하고 있는 일과 작업하고 있는 것을 시각화할 수 있도록 설명이 필요합니다.
설명 내용 및 구성
다음은 설명에서 일반적으로 볼 수 있는 섹션에 대한 리뷰입니다. 읽으면서 예시 설명을 확인해 보세요.
소개. 설명을 소개하는 부분을 신중하게 계획하세요. 다음 사항들이 모두 포함되도록 하되 (필요하다면 이 순서대로 하지 않아도 괜찮습니다) 귀하의 설명에 적용되는 것들을 확인하세요:
- 설명될 특정 물체를 표시하십시오.
- 청중이 설명을 이해하기 위해 필요한 지식과 배경을 명시하십시오.
- 객체에 대한 일반적인 설명을 제공하십시오.
- 내용 설명에 대한 개요를 포함하세요.
배경. 대부분의 독자에게 익숙하지 않을 가능성이 있는 것을 설명하고 있다면, 실제 설명에 들어가기 전에 배경 정보를 추가하는 것이 좋습니다. 비전문가에게 SGO/3 밀도 계측기를 설명하려고 한다면, 먼저 그것이 무엇인지, 무엇을 하는지, 그리고 지구의 어떤 부분에서 사용되는지에 대해 이야기하는 것이 좋습니다.
부분이나 특징에 대한 토론. 당신의 설명의 주요 부분은 각 부분이나 특징에 대한 논의입니다. 당신이 설명하고 있는 것을 부분이나 특징, 또는 둘 다로 나누어야 합니다. 부품 쉬운 것들입니다: 예를 들어, 나무로 된 연필에는 심이 있고, 나무통이 있으며, 지우개와 금속 클립이 있습니다. 특징 사물의 설명 가능한 측면이지만 부분이 아닌 것들: 예를 들어, 연필은 특정한 무게, 길이, 너비 등을 가지고 있습니다. 만약 당신이 유망한 부동산 재벌이 되어 회사 파일을 위해 빈 부지를 설명해야 한다면, 아마 그 특성으로 설명할 것입니다: 위치, 면적, 지형, 식생, 유틸리티 접근성 등. (예시의 원시 돌 스크래퍼 설명을 확인해 보세요; 그 일부는 특성에 따라 배열되어 있고, 일부는 부분에 따라 배열되어 있습니다!)
당신이 설명하고 있는 대상을 부분, 특성 또는 둘 다로 나눈 후, 다음 작업은 각각을 설명하는 것입니다. 기계적인 것들에 대해서는 부품을 정의하고 그 기능을 설명하는 것으로 시작하는 것이 좋습니다. 그 후에는 적절한 설명의 출처를 사용하여 일반적인 것에서 구체적인 것으로 부품을 설명합니다.
설명에서 다른 종류의 글쓰기를 혼합할 수 있다는 점에 유의하세요. 기능을 설명하고, 용어를 정의하고, 설명하는 과정의 일부를 논의하게 될 것입니다. 주요 초점과 내용의 대부분이 진정한 설명인 한, 그건 문제가 되지 않습니다.
관련 작업 또는 프로세스에 대한 논의. 어떤 설명의 일부에서, 종종 끝부분에, 당신이 설명하는 객체와 관련된 작업이나 과정을 요약하는 것이 유용합니다. 예를 들어, 만약 당신이 기계식 연필을 방금 설명했다면, 그것이 어떻게 사용되는지 간단히 설명할 수 있습니다. 만약 당신이 눈꽃을 방금 설명했다면, 그것이 형성되는 과정을 논의할 수 있습니다.
설명의 출처
설명을 쓸 때, 제공할 수 있는 묘사 세부 사항의 종류에 대해 생각할 필요가 있습니다. 가끔 설명이 이 부분에서 다소 약할 수 있습니다. 다음 목록을 사용하여 설명을 계획하거나 작성한 설명을 검토하세요. 제공할 수 있는 묘사 세부 사항의 범주를 생각해 보거나, 다음 목록을 사용하여 사용하지 않은 범주를 식별하세요:
|
색상 높이 너비 형태 무게 재료 질감 위치 부착 방법 냄새 |
깊이 금액 패턴, 디자인 재료 나이 서브파트 길이 끝내다 온도 수분 함량 |
설명에 대한 도식적 보기. 이것은 내용과 조직을 위한 전형적이거나 일반적인 모델일 뿐임을 기억하세요 — 다른 많은 모델이 가능합니다.
기타 우려 사항
설명에서는 숫자, 약어 및 기호를 어떻게 처리할지 고민하게 될 것입니다:
숫자. 기술 작성은 과거 작문 수업에서 열심히 배운 몇 가지 규칙을 깨뜨린다는 점을 기억하세요. 기술 작성 맥락에서는 숫자가 매우 중요하며, 이를 눈에 띄게 하고 싶어합니다. 이는 숫자가 정확하고, 측정된 혹은 측정 가능한 양을 나타내거나 중요한 값을 나타낼 때 본문 내에서 숫자를 사용해야 함을 의미합니다. 예를 들어, 이러한 문장에서는 숫자가 정확하다는 것이 중요한 것 같습니다:
컵의 지름은 3인치입니다.
포스터를 벽에 고정하려면 4개의 압핀을 사용하세요.
하지만, 이것은 무관한 값에 대해 숫자를 사용하는 것을 의미하지 않습니다. 예를 들어, 이 문장에서 보고서에 섹션이 몇 개 있는지는 심장을 멎게 할 만한 것이 없습니다:
보고서는 네 가지 주요 섹션으로 구성되어 있습니다.
섹션을 참조하세요. 숫자 vs. 단어 자세한 내용은.
서술 단락의 구조. 일반적으로, 이는 부품의 목적이나 기능에 대한 일부 진술로 시작되며, 그 뒤에 설명적인 세부사항이 이어집니다. 설명적인 세부사항은 색상, 형태, 너비 및 높이와 같은 설명의 "출처"를 활용합니다.—
약어. 기술 문서 작성에서 약어를 보게 될 것으로 기대합니다. 설명에서 자유롭게 사용하세요. 약어의 문장 부호에 대한 규칙을 기억하세요—단어를 형성하는 경우에만 문장 부호를 사용하세요 (예: "안."). 또한 약어가 그렇다는 것도 기억하세요. 아니요 위에서 사용된 숫자에 맞서 싸우다 (예: "8 mm 테이프" 또는 "8-mm 테이프" 하지만 아니다 "8mm 테이프").
기호. 지침 및 설명에서 기호와 관련된 가장 일반적인 문제는 인치와 피트와 관련이 있습니다. 만약 목수의 꿈의 프로젝트에 대한 지침을 작성하고 있다면, 곳곳에 피트와 인치가 있다면 기호 " (인치)와 ' (피트)를 사용하세요. 그러나 인치 및 피트 측정을 몇 번만 인용하는 경우에는 대신 단어 또는 약어를 사용하세요.
설명에서의 그래픽 및 형식
대부분의 설명에서, 당신이 설명하는 것의 일러스트레이션이 최소한 하나 필요하며, 부품을 가리키는 레이블이 있어야 합니다. 섹션을 참조하세요. 그래픽스 그래픽 만들기, 형식 지정, 설명에 통합하는 방법에 대한 자세한 내용은 참고하십시오.
헤딩. 설명에서는 각 개별 부분이나 특성에 대한 논의를 구분하기 위해 제목과 부제목을 사용하는 것이 좋습니다. 이상적으로는 각 부분을 별도의 단락이나 섹션에서 설명하고, 그 논의에는 제목을 표시해야 한다는 점을 기억하세요. 배경 섹션이 있다면, 그것도 제목을 사용하세요. 섹션을 참조하세요. 제목 특정 요구 사항에 대해.
목록. 설명에서 목록은 지침에서만큼 중요하지 않습니다. 그러나 부품이나 하위 부품을 항목화하거나 사양을 나열할 경우, 이러한 상황은 목록에 적합합니다. 섹션을 참조하십시오. 목록들 특정 요구 사항에 대해.
특별 공지 사항. 설명에서는 지침에서처럼 특별 공지의 중요한 역할이 없습니다. 결국, 만약 정말로 설명이라면, 독자들은 어떤 절차를 따르려고 해서는 안 되며, 따라서 장비 손상, 자원 낭비, 절차 오류, 자신이나 타인 부상의 위험을 감수해서는 안 됩니다. 그러나 여러분은 다음을 찾을 수 있습니다. 노트 중요한 사항이나 예외를 강조하기 위해 유용한 특별 공지. 섹션을 참조하세요. 특별 공지사항 이 특별 공지의 적절한 사용 방법과 지침 내에서의 형식 및 배치에 대한 완전한 논의를 위해.
이 장에 대한 당신의 생각, 반응, 비판을 듣고 싶습니다: 응답—데이비드 맥머리
