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