도와주려면 여기를 클릭해 주세요. 데이비드 맥머리 웹 호스팅 비용 지불:
가능한 작은 금액이라도 기부해 주세요!
온라인 기술 문서 작성은 계속 무료로 제공됩니다.
설명을 작성할 때 당신이 직면할 수 있는 가장 큰 장애물은 이 문맥에서 그 용어가 의미하는 바를 기억하는 것이다. 우리 모두는 그 단어를 사용한다 설명 거의 모든 논의나 설명을 느슨하게 가리키는 데 쓰인다. 그러나 이 문맥에서는 그것이 의미하는 것은 어떤 것의 물리적 측면에 대한 상세한 논의즉 색상, 형태, 크기, 무게, 높이, 너비, 두께, 질감, 밀도, 내용물, 제작 재료 등과 같은 것들을 논의하는 것을 의미한다.
예를 들어, 이 문장은 우리가 말하는 의미에서 진정한 '서술'이 아니다:
컴퓨터 디스켓은 전자 데이터를 저장하는 데 사용되는 장치입니다.
그것은 기능이나 목적을 설명하지만 물리적 세부 사항은 거의 또는 전혀 제공하지 않는다. 그러나 이 문장은 분명히 묘사적이다:
1980년대의 일반적인 컴퓨터 디스켓은 크기가 3.5인치×3.5인치였고 두께는 약 1/8인치였다.
꼭 확인해 보세요 예시 설명 이 장과 함께 제공됩니다.
NotebookLM이 생성한 이 장의 인포그래픽
설명을 위한 맥락
앞서 언급했듯이, 설명은 기술 문서에서 흔한 요소입니다—단, 설명은 지침과 꼭 같은 방식으로 나타나지는 않습니다. 설명은 여기저기 한두 문장으로 나타나기도 하고, 어떤 곳에서는 한 단락으로, 또 다른 곳에서는 전체 섹션으로 등장하기도 합니다. 특정 유형의 기술 문서에는 설명이 포함됩니다:
- 상세한 설명이 필요한 사고 보고서들.
- 제품 사양—신제품 또는 변경된 제품의 설계와 특징을 설명하는 문서—에는 설명이 풍부하다.
- 지침은 독자들이 무엇을 하고 있는지, 무엇을 다루고 있는지를 시각화할 수 있도록 설명이 필요한 경우가 많다.
설명의 내용 및 구성
다음은 설명에서 흔히 볼 수 있는 섹션들에 대한 검토입니다. 읽으면서 예시 설명들을 확인해 보세요.
소개. 설명 도입부를 신중하게 계획하세요. 해당 설명에 적용되는 다음 항목들(반드시 이 순서일 필요는 없음)을 모두 충족하도록 하세요:
- 곧 설명될 특정 대상을 가리키세요.
- 설명을 이해하기 위해 청중이 갖추어야 할 지식과 배경을 명시하세요.
- 물체에 대한 일반적인 설명을 제공해 주세요.
- 설명의 내용에 대한 개요를 포함하세요.
배경. 당신이 설명하려는 대상이 대부분의 독자에게 익숙하지 않을 것 같다면, 실제 설명에 들어가기 전에 약간의 배경을 덧붙이는 것을 고려해 보라. 비전문가에게 SGO/3 밀도 게이지를 설명하려 한다면, 그게 도대체 무엇인지, 어떤 역할을 하는지, 그리고 지구의 어느 지역에서 사용되는지 먼저 설명하는 것이 좋다.
부분 또는 특성에 대한 논의. 설명의 주요 부분은 각 부분 또는 특성에 대한 논의입니다. 당신이 묘사하는 대상을 부분이나 특성, 또는 둘 다로 나누어야 합니다. 부품 쉽다: 예를 들어, 나무 연필에는 흑연심, 나무 몸통, 지우개, 그리고 금속 클립이 있다. 특성 특성은 어떤 것의 기술 가능한 측면들이지만 부분은 아니다: 예를 들어, 연필은 특정한 무게, 길이, 너비 등을 가진다. 만약 당신이 떠오르는 부동산 거물이고 회사 문서를 위해 공터를 묘사해야 한다면, 아마 그 부지를 특성으로 묘사할 것이다: 위치, 면적(평방피트), 지형, 식생, 공공시설 접근성 등등. (예시에 있는 원시 석기 긁개의 설명을 살펴보라; 그 설명의 일부는 특성별로 정리되어 있고 일부는 부분별로 정리되어 있다!)
대상을 부분, 특성 또는 둘 다로 나눈 후에는 다음으로 각각을 설명해야 한다. 기계적인 것의 경우에는 먼저 그 부품을 정의하고 그 기능을 설명하는 것부터 시작하는 것이 효과적이다. 그 다음에는 적절한 서술 수단을 사용하여 그 부품을 일반적인 것에서 구체적인 것 순으로 설명한다.
설명에서는 다른 종류의 글을 섞어 쓸 수 있다는 점에 유의하세요. 설명하는 동안 기능을 설명하고 용어를 정의하며 과정을 약간 논의하게 될 것입니다. 주된 초점과 내용의 대부분이 진정으로 설명적이라면 그것은 문제가 되지 않습니다.
관련 작업 또는 프로세스에 대한 논의. 설명 중 어느 시점, 보통 끝부분에서, 설명하고 있는 대상과 관련된 작동 방식이나 과정을 요약하는 것이 유용하다. 예를 들어 방금 기계식 연필을 설명했다면 그것이 어떻게 사용되는지 간단히 설명할 수 있고, 방금 눈송이를 설명했다면 그것이 형성된 과정을 논할 수 있다.
설명의 출처
묘사를 작성할 때 제공할 수 있는 묘사적 세부사항의 종류에 대해 생각해야 합니다. 때로는 묘사가 이 부분에서 다소 약할 수 있습니다. 다음 목록을 사용하여 묘사를 계획하거나 작성한 묘사를 검토하십시오. 제공할 수 있는 묘사적 세부사항의 범주를 생각하거나, 다음 목록을 사용하여 아직 사용하지 않은 범주를 확인하십시오:
|
색 높이 너비 모양 무게 재료 텍스처 위치 부착 방법 냄새 |
깊이 금액 패턴, 디자인 재료 나이 하위 항목 길이 끝내다 온도 수분 함량 |
설명의 개략도. 이것이 내용과 구성에 대한 전형적이거나 일반적인 모델일 뿐이라는 것을 기억하십시오—많은 다른 것들이 가능합니다.
기타 우려 사항
설명에서는 아마 숫자, 약어, 기호를 어떻게 처리해야 할지 고민하게 될 것입니다:
숫자들. 기술적 글쓰기는 과거 작문 수업에서 열심히 배운 몇몇 규칙을 어긴다는 것을 기억하세요. 기술 문서의 맥락에서는 숫자가 매우 중요하고 눈에 띄기를 원할 때가 많습니다. 이는 숫자가 정확한, 측정된 또는 측정 가능한 양을 나타내거나 중요한 값을 의미할 때 본문에서는 숫자를 아라비아 숫자로 표기해야 한다는 뜻입니다. 예를 들어 다음 문장들에서는 숫자가 정확하다는 것이 중요해 보입니다:
그 컵의 지름은 3인치입니다.
포스터를 벽에 고정하려면 압정 4개를 사용하세요.
하지만 이것이 중요하지 않은 값들에 대해 숫자를 사용해도 된다는 뜻은 아니다. 예를 들어, 이 문장에서 보고서에 섹션이 몇 개 있는지는 전혀 긴장되거나 놀랄 만한 일이 아니다:
보고서는 네 개의 주요 섹션으로 구성되어 있습니다.
해당 섹션을 참조하세요 숫자 대 단어 자세한 내용은.
묘사 단락의 구조. 일반적으로 그 부분의 목적이나 기능에 관한 어떤 진술로 시작하고, 그 뒤에 묘사적 세부사항이 따른다. 묘사적 세부사항은 "출처"의 설명—인 색깔, 형태, 너비 및 높이와 같은 것들을 바탕으로 한다.
약어. 기술 문서에서는 약어를 보는 것이 일반적입니다. 설명에서 자유롭게 사용하세요. 약어에 마침표를 찍는 규칙을 기억하세요—단어를 이루는 경우에만 마침표를 찍으세요(예: "인."). 또한 약어는 아니다 사용되는 숫자와 바로 붙여 쓰세요 (예: "8 mm tape" 또는 "8-mm tape"로 하되 아니다 "8mm 테이프").
기호. 지침과 설명에서 기호와 관련된 가장 흔한 문제는 인치와 피트입니다. 사방에 피트와 인치가 널려 있는 목수의 꿈 프로젝트에 대한 지침을 작성하는 경우, 기호 "(인치)와 ' (피트)를 사용하세요. 그러나 인치와 피트 측정값을 몇 번만 인용하는 경우에는 대신 단어나 약어를 사용하세요.
설명에서의 그래픽 및 형식
대부분의 설명에서는 설명하는 대상의 부분을 가리키는 레이블이 붙은 적어도 하나의 삽화가 필요합니다. 이에 관한 섹션을 참조하세요. 그래픽스 그래픽을 만들고, 서식을 지정하고, 이를 설명에 통합하는 방법에 대한 자세한 내용.
제목 설명에서는 개별 부분이나 특성에 대한 논의를 구분하기 위해 제목과 부제목을 사용하는 것이 좋습니다. 이상적으로는 각 부분을 별도의 단락이나 섹션—으로 설명하고 그 논의를 제목으로 표시해야 한다는 점을 기억하세요. 배경 섹션이 있다면 그 부분에도 제목을 사용하세요. 해당 섹션을 참조하세요. 제목 특정 요구 사항을 위해.
목록들. 목록은 설명에서 지침만큼 중요하지 않습니다. 그러나 부품이나 하위 부품을 항목별로 정리하거나 사양을 나열하는 경우에는 목록을 사용하는 것이 적절한 상황입니다. …에 관한 섹션을 참조하십시오. 목록들 특정 요구 사항을 위해.
특별 공지사항. 설명에서는 지시문에서처럼 특별 주의사항이 차지하는 중요한 역할이 없다. 어쨌든 그것이 진정한 설명이라면 독자들은 어떤 절차를 따르려고 해서는 안 되며, 따라서 장비를 손상시키거나 소모품을 낭비하거나 절차를 망치거나 자신이나 다른 사람을 다치게 할 위험을 감수하지 않아야 한다. 그러나 당신은 ...을 발견할 수도 있다 메모 중요한 사항이나 예외를 강조하는 데 유용한 특별 공지입니다. 해당 섹션을 참조하세요 특별 공지사항 이러한 특별 공지의 적절한 사용법 및 그 형식과 지침 내 배치에 대한 전체 논의를 위해.
이 장에 대한 의견, 반응, 비판을 알려주시면 감사하겠습니다: 응답—데이비드 맥머레이
