내용 확인
거친 초안을 검토할 수 있는 가장 중요한 방법 중 하나는 내용 확인하는 것입니다—그게 얼마나 분명합니까! 세상에 있는 모든 좋은 전환, 좋은 조직, 명확한 문장 구조도 올바른 내용이 없는 기술 문서를 도와줄 수 없습니다. 기술 문서의 내용은 여러 가지 방법으로 "잘못될 수 있습니다".
- 전체가 빠질 수도 있습니다: 예를 들어, 누군가 "가상 커뮤니티"에 대한 보고서를 작성했지만 그 용어가 무엇인지 정의하는 데 신경 쓰지 않았다면, 그 보고서의 시작부터 힘들어질 것입니다.
- 그것이 있지만 충분하지는 않다: 동일한 예를 들어—작가가 가상 커뮤니티에 대해 몇 가지 모호한 진술만 했다면. 필요했던 것은 최소한 이 주제에 대한 한 문단이었고, 아니면 3페이지 또는 4페이지로 구성된 완전한 섹션이었어야 했다.
- 있지만 청중에게 맞지 않는 수준이다: 독자의 지식, 배경 또는 필요 측면에서 잘못된 수준으로 정보를 제시하는 것도 가능하다. 작가가 데이터 캐싱에 대한 3페이지 분량의 세션을 포함했지만, 보고서가 실제로 비전문가를 대상으로 할 때 제품 개발자(전문가) 청중을 위해 작성했다면 상상해 보라.
보고서 초안에서 정보가 부족하다는 인상을 받을 수 있다면, 어떤 구체적인 작업을 통해 수정해야 할지를 아는 데 잘 준비된 상태입니다. 유용한 브레인스토밍 도구 중 하나는 다음과 같은 측면에서 생각하는 것입니다. 종류 내용의.
제공된 질문을 사용하세요. 문서 내용 귀하의 초안을 검토하여 추가하거나 변경할 정보 유형을 확인하십시오.
내용의 구조를 확인하세요.
문서의 정보 조직을 바라보는 두 가지 방법이 있습니다:
- 다음 섹션에서 다루는 하나는 정보 조각의 순서를 살펴보고, 그것들이 올바른 순서인지 확인하는 것입니다.
- 또 다른 것은 정보의 수준과 관련이 있습니다. 초안의 문장이나 단락을 살펴보면 어떤 문장은 주제에 대한 더 깊은 논의로 나아가는 반면, 다른 문장은 그런 깊이 있는 문장이 의존하는 틀처럼 작용합니다. 이런 방식으로 구조를 살펴보면 조직을 점검할 수 있을 뿐만 아니라 텍스트의 내용을 개선하는 데 도움이 되는 좋은 아이디어도 많이 얻을 수 있습니다.
자세한 설명은 다음에서 제공됩니다. 조정과 종속 단락으로.
조직 확인
보고서에 올바른 내용이 있다면, 독자에게 모든 "올바른 자료"를 제공한 셈입니다. 그러나 여전히 충분히 조직되지 않았을 수 있습니다—마치 방금 이사한 것처럼 모든 것이 엉망이거나 여전히 상자에 들어 있을 때처럼. 초안의 조직을 검토하기 위해 필요한 두 가지 필수 기술이 있습니다:
- 다양한 수준의 정보 조각들의 주제를 식별하다. 문단의 조직을 평가하기 위해, 각 문단의 주제를 식별할 단어나 구를 생각하는 것부터 시작합니다. 즉, 각 문단을 이해하는 것입니다. 그런 다음, 그 단어나 구에서 물러나서, 그것들이 올바른 순서에 있는지를 고려합니다. 하지만, 그것은 단지 한 단계일 뿐입니다. 당신은 또한 볼 수 있습니다. 내부의 각 문단의 조직을 위한 개별 문단. 이 경우, 각 문장의 주제를 식별하고 해당 문장의 순서를 고려합니다.
- 정보의 덩어리에 대해 최상의 순서를 선택하세요. 각 정보 조각의 주제를 알게 되면 (당신이 조사하는 어떤 수준에서든) 그것들이 올바른 순서인지 결정할 수 있습니다. 이 결정은 일반적인 순서 패턴을 아는 것을 포함합니다. 여기 몇 가지 예가 있습니다:
- 일반 → 특정: 내용을 일반적인 것에서 구체적인 것으로 배열하는 것이 조직하는 일반적인 방법입니다. 예를 들어, 정의하기 모두 태양열 집열기는 다양한 태양열 집열기의 유형에 대해 논의하는 것보다 더 일반적인 논의입니다. 특정 유형의 태양열 집열기의 작동을 설명하는 것은 훨씬 덜 일반적입니다. 이 패턴은 여기에서 설명됩니다:
일반에서 구체적으로 조직된 패턴으로 개정하기. 모든 태양열 집열기가 하는 일을 정의한 다음, 그들의 다양한 유형으로 넘어가는 것이 더 자연스러운 진행입니다. - 간단하고 기본적인 → 복합체: 토론의 단위를 배열하는 또 다른 방법은 간단하고 기본적인 것들로 시작한 다음 더 복잡하고 기술적인 것으로 넘어가는 것입니다.
- 정지한 → 움직이는 물체: 또 다른 조직 패턴은 먼저 대상을 설명한 다음(사진처럼), 그 작동이나 과정을 논의하는 것입니다(비디오처럼). 이 접근 방식은 연료 분사 시스템에 대한 논의에 잘 어울릴 수 있습니다.
- 공간 이동: — 무언가의 물리적 세부 사항을 설명하고 있다면, 위에서 아래로, 왼쪽에서 오른쪽으로, 또는 바깥에서 안으로와 같은 물리적 움직임의 패턴을 사용하고 싶을 수 있습니다.
- 시간적 이동: — 가장 일반적인 패턴 중 하나는 시간의 흐름에 따른 이동을 기반으로 하며, 사건에 대한 논의를 시간적 순서에 따라 정리합니다.
- 개념 → 개념의 적용, 예시일반적인 조직 패턴은 개념을 일반적인 용어로 논의한 다음 그 적용에 대해 논의하는 것입니다. 예를 들어, 이 책의 또 다른 장에서는 제안을 먼저 개념적으로 논의한 다음 제안의 예에 대해 논의합니다.
- 데이터 → 결론: 정보를 정리하는 또 다른 방법은 데이터를 제시한 다음 (관찰, 실험 데이터, 설문 결과) 그 데이터에서 도출할 수 있는 결론으로 넘어가는 것입니다. (이 패턴은 경우에 따라 반대로 진행될 수도 있습니다: 결론을 먼저 제시한 다음 이를 뒷받침하는 데이터를 제공합니다.)
- 문제, 질문 → 해결책, 답변: 문제를 논의하거나 질문을 제기한 다음 해결책이나 답변으로 넘어가면서 정보를 조직할 수도 있습니다.
- 간략화된 버전 → 자세한 버전: 비전문가에게 기술적인 문제를 설명하는 유용한 방법은 그 사물의 단순화된 버전에 대해 이야기하는 것으로 시작하여 이를 확실히 이해한 다음, 다시 돌아가 기술적인 세부사항을 두껍고 무겁게 덧붙여 다시 설명하는 것입니다!
- 가장 중요한 → 가장 덜 중요한: 보다 "수사학적인" 조직 방법은 가장 중요하고, 가장 주목을 끌며, 가장 극적인 정보를 먼저 시작한 다음 점차적으로 덜 중요한 정보로 넘어가는 것입니다. (그리고 이 패턴은 반대로도 할 수 있습니다: 클라이맥스를 먼저 시작하는 대신 그것을 쌓아올릴 수 있습니다.)
- 가장 설득력 있는 → 가장 설득력 없는: — 비슷하게, 당신의 입장을 위한 가장 설득력 있는 주장에서 시작하여 —모두의 관심을 끌고 —따라 점점 덜 설득력 있는 주제로 넘어갈 수 있습니다. (이 패턴은 반대로도 적용될 수 있습니다: 가장 설득력 있는 주장으로 뒷받침할 수 있습니다.)
- 일반 → 특정: 내용을 일반적인 것에서 구체적인 것으로 배열하는 것이 조직하는 일반적인 방법입니다. 예를 들어, 정의하기 모두 태양열 집열기는 다양한 태양열 집열기의 유형에 대해 논의하는 것보다 더 일반적인 논의입니다. 특정 유형의 태양열 집열기의 작동을 설명하는 것은 훨씬 덜 일반적입니다. 이 패턴은 여기에서 설명됩니다:
이것은 몇 가지 가능성에 불과합니다. 정보 전달이 목표일 때는 독자가 복잡하고 기술적인 내용을 다루기 전에 기본 사항을 이해하도록 정보를 배열합니다. 설득이 목표일 때는 독자에게 설득 효과를 극대화하기 위해 가장 강력한 주장을 먼저 배치하는 등 방법을 배열합니다.
그리고 어떤 경우이든 이러한 접근 방식을 혼합하는 것을 피하세요—예를 들어, 데이터를 일부 버린 다음 몇 가지 결론을 제시하고, 그 후 이런 식으로 앞뒤로 지저분하게 돌아다니는 것입니다. 사과는 오렌지와 분리하세요!
주제 문장과 개요를 강화하다
가장 좋은 방법 중 하나는 초안을 다시 살펴보며 중요한 부분에 주제 문장과 개요를 삽입할 수 있는지 확인하는 것입니다. 글을 쓸 때, 우리는 일반적으로 단락이나 섹션이 그 내용과 논리 측면에서 어디로 가고 있는지 정확히 알지 못합니다. 일단 "도달했을 때," 종종 처음으로 돌아가서 어떤 형태의 개요를 추가하거나 이미 있는 내용을 수정하여 개요를 더 명확하게 만드는 것이 필요합니다. 독자는 보고서에서 자신이 어디로 가고 있는지, 다음에 무엇이 올지, 그리고 방금 어디에 있었는지를 알아야 합니다.
보고서에서 개요를 갖는 것은 새로운 도시에서 지도를 갖는 것과 같습니다. 주제 문장과 개요는 주제, 하위 주제, 향후 논의의 목적, 이전 섹션 및 문서 전체와의 관계에 대한 시각을 제공합니다. (이제 이 중 일부는 전환을 포함하는데, 이는 다음으로 검토할 요소입니다.)
이 주제에 대한 자세한 내용은 주제 문장과 개요.
일관성 및 전환 강화
보고서에서 올바른 정보를 가지며 적절히 정리할 수 있지만, 여전히 중요한 일이 잘못될 수 있습니다. 독자들은 아이디어의 "흐름"을 놓치거나, 정보 덩어리들 간의 관계나 연결성을 파악하는 데 어려움을 겪을 수 있습니다. 독자가 필요로 하는 것은 지속적인 안내—이며, 이것은 여러분이 작가로서 제공하는 것입니다. 그리고 여러분이 그 안내를 제공하는 데 사용하는 것을 전환—이라고 하며, 이는 독자가 문서를 통해 나아가도록 도와주는 다양한 장치입니다. 문서의 모든 문장을 연결하는 논리가 있으며, 이는 문장들 간의 특정한 순서를 결정합니다.
장에 대해 참조하십시오. 일관성 및 전환 자세한 논의와 예를 위해.
단락 길이 확인
최종적으로 초안의 구조 수준에서 검토하는 방법 중 하나는 단락 구분을 어떻게 정의했는지 확인하는 것입니다. 단락은 이상한 존재로, 일부 작문 학자들은 그것이 존재하지 않으며 작가가 원하는 때와 장소에 임의로 삽입하는 구간에 불과하다고 믿습니다. 죄송합니다. 기술 작문에서는 단락이 명확성과 이해를 위한 전투에서 핵심적인 역할을 합니다. 항상 가능한 것은 아니지만, 단락은 주제나 하위주제의 변화 또는 주제가 논의되는 방식의 변화가 있을 때 발생해야 합니다.
싱글 스페이스로 작성된 한 페이지에서, 문단 나눔을 하나에서 네 개 찾으세요 — 그 평균에 마법적인 것은 없으니 법처럼 취급하지 마세요. 긴 문단을 다시 한번 살펴보고 문단 나눔의 가능성을 확인해 보세요.
이 장에 대한 당신의 생각, 반응, 비판을 주시면 감사하겠습니다: 당신의 답변—데이비드 맥머리.
