여기를 클릭하여 도와주세요. 데이비드 맥머리 웹 호스팅 비용 지불:
작은 금액이라도 기부해 주세요!
온라인 기술 작문은 무료로 유지됩니다.
기술 문서—또는 그 어떤 글의 독자는—의도된 독자 또는 잠재적 독자입니다. 대부분의 기술 작가에게 있어서, 이는 가장 중요한 문서를 계획하고 작성하며 검토할 때 고려해야 할 사항입니다. 당신은 독자들이 읽을 때의 필요, 관심사, 배경에 맞춰 당신의 글을 조정해야 합니다.
원칙은 터무니없이 간단하고 명백해 보입니다. 누군가에게 말하는 것과 비슷합니다, "앞에 있는 사람이 당신이 하는 말을 이해할 수 있도록 이야기하세요." 마치 "당신의 6세 아이에게 로켓 과학 이야기를 하지 마세요."라고 말하는 것과 같습니다. 그런 수업이 필요할까요? 그렇게 보이지 않습니다. 하지만 실제로, 청중 분석 및 적응 부족은 전문 기술 문서에서 발견되는 대부분의 문제의 근본 원인 중 하나입니다—특히 가장 두드러지게 드러나는 지침에서 그렇습니다.
노트:
- 청중에 관한 섹션을 읽고 나면, 다음을 시도해 보세요. 청중 계획자. 당신은 청중에 대한 자세한 질문에 대한 답변으로 빈칸을 채우고 그것을 자신에게 이메일로 보내고, 선택적으로 강사에게도 보냅니다.
- 또한, 이 장에는 다음에 대한 섹션이 포함되어 있습니다. 상황. 사용해 보세요. 상황 계획자 청중이 처해 있는 상황에 대한 아이디어를 개발하기 위해.
청중을 분석할 때 가장 먼저 해야 할 일 중 하나는 그 유형(또는 유형들—이것은 드물게 단 하나의 유형만으로 한정되지 않습니다.)을 식별하는 것입니다. 청중을 카테고리로 나누는 일반적인 기준은 다음과 같습니다:
- 전문가: 이들은 이론과 제품에 대해 모든 것을 아는 사람들입니다. 그들이 설계했고, 테스트했으며, 그에 대해 모든 것을 알고 있습니다. 종종 그들은 고급 학위를 가지고 있으며, 학문적 환경이나 정부 및 기술 분야의 연구 개발 영역에서 활동합니다. 비전문 독자는 이들이 하는 말을 이해할 가능성이 가장 적지만, 또한 이해하려고 할 이유도 가장 적습니다. 더 자주, 전문가가 직면하는 커뮤니케이션 문제는 기술자와 경영진에게 소통하는 것입니다.
- 기술자: 이들은 전문가들이 설계하고 이론화하는 것들을 구축하고, 운영하고, 유지 관리하고, 수리하는 사람들입니다. 그들의 지식도 매우 기술적이지만, 더 실용적인 성격을 가지고 있습니다.
- 경영진: 이들은 전문가와 기술자들이 다루는 것에 대해 비즈니스, 경제, 행정, 법률, 정부, 정치적 결정을 내리는 사람들입니다. 만약 새로운 제품이라면, 그들은 그것을 생산하고 마케팅할지 결정합니다. 새로운 에너지 기술이라면, 그들은 도시에서 그것을 시행해야 하는지 결정합니다. 경영진은 비전문가만큼 그 주제에 대한 기술적 지식이 적을 가능성이 높습니다.
- 비전문가: 이 독자들은 모든 사람 중에서 가장 적은 기술 지식을 가지고 있습니다. 그들의 관심은 기술자들과 마찬가지로 실용적일 수 있지만 다른 방식으로 나타납니다. 그들은 다가오는 채권 선거에서 새로운 전력 기술에 대해 찬성할지 반대할지 알 만큼 이해하고 싶어합니다. 또는 그들은 특정 기술 문제에 대해 단순히 호기심이 생겨서 그것에 대해 배우고 싶어할 수 있습니다—하지만 특별한 실용적인 이유는 없습니다.
청중 분석
당신의 문서의 잠재 독자가 어떤 네 가지 카테고리에 속하는지를 파악하는 것은 중요하지만, 그게 전부는 아닙니다. 카테고리에 관계없이 청중은 다음과 같은 특성 측면에서도 분석되어야 합니다:
- 배경—지식, 경험, 훈련: 당신의 가장 중요한 우려 사항 중 하나는 독자들이 얼마나 많은 지식, 경험 또는 훈련을 가지고 있을지에 대한 것입니다. 독자 중 일부가 특정 배경 지식이 부족할 것이라고 예상한다면, 문서에서 자동으로 그 정보를 제공해야 할까요? 예를 들어, 마이크로소프트 윈도우에서 실행되는 소프트웨어 제품 사용에 대한 가이드를 작성한다고 가정해 보세요. 독자들이 윈도우에 대해 얼마나 알고 있을 것이라고 기대할 수 있을까요? 만약 일부 독자들이 윈도우에 대해 거의 모를 것 같다면, 그 정보를 제공해야 할까요? 아니라고 한다면, 고객들이 제품에 대해 불만을 가질 위험이 있습니다. 윈도우에 대한 배경 정보를 추가해야 한다고 한다면, 작업 노력이 늘어나고 문서의 페이지 수가 증가하게 됩니다(그에 따라 비용도 증가하게 됩니다). 명백히 이 질문에 대한 쉬운 답은 없습니다. 답변의 일부는 청중의 아주 작은 세그먼트가 그 배경 정보를 필요로 하는지에 따라 달라질 수 있습니다.
- 필요와 관심: 문서를 계획하려면 독자가 그 문서에서 무엇을 기대할지 알아야 합니다. 독자들이 문서를 어떻게 사용할지 상상해 보세요; 그들이 무엇을 요구할 것인지. 예를 들어, 새로운 스마트폰에 대한 매뉴얼을 작성한다고 상상해 보세요. 독자들은 그 안에서 무엇을 기대할까요? 국가 부동산 협회를 위해 지구 온난화에 대한 배경 보고서를 작성하라는 계약을 맺었다고 상상해 보세요. 그들은 어떤 정보를 읽고 싶어할까요; 그리고, 마찬가지로 중요한 것은, 그들이 무엇을 원할까요? 아니다 무엇에 대해 읽고 싶으신가요?
- 다른 문화: 국제 관객을 위해 글을 쓴다면, 시간 및 날짜, 금액 및 수치 표시 형식이 전 세계적으로 다르다는 점에 유의해야 합니다. 또한 유머와 비유적 표현("홈런을 치다"와 같은)은 우리 문화 밖에서는 이해되지 않을 가능성이 높다는 점도 알아야 합니다. 텍사스 A&M 대학교에서는 제공하고 있습니다. 제6장, "국제 독자를 위한 글쓰기," 의 기술 정보 보고, 엘리자베스 테비옥스 외. 기준은 다음을 참조하세요. 스타일 가이드 목록 위키백과에서. (이 중요한 아이디어들을 기여한 익명의 손님에게 감사합니다.)
- 기타 인구 통계적 특성: 물론 독자에 관한 다른 많은 특성들도 있습니다. 할 수 있다 문서—를 디자인하고 작성하는 방법에 영향을 미치는 요소들에는 예를 들어, 연령대, 거주 형태, 거주 지역, 성별, 정치적 선호도 등이 있습니다.
청중 분석은 최소한 두 가지 다른 요인으로 복잡해질 수 있습니다: 하나의 문서에 대한 혼합된 청중 유형, 청중 내의 폭넓은 변동성, 그리고 알려지지 않은 청중들.
- 하나 이상의 청중. 당신의 문서가 한 가지 이상의 청중을 대상으로 하고 있을 가능성이 높습니다. 예를 들어, 기술자(전문가 및 기술자)와 행정 직원(경영진)이 이를 볼 수 있습니다. 어떻게 해야 할까요? 모든 섹션을 모든 청중이 이해할 수 있도록 작성할 수 있습니다(행운을 빕니다!). 아니면 각 섹션을 해당 청중이 관심을 가질 수 있도록 엄격하게 작성한 다음, 제목과 섹션 소개를 사용하여 청중에게 문서에서 어디로 가야 하고 무엇을 피해야 하는지를 알릴 수 있습니다.
- 청중의 폭넓은 다양성. 독자가 하나의 범주에만 들어맞는 것처럼 보이더라도, 그 배경에는 광범위한 다양성이 있음을 깨달을 수 있습니다. 이는 어려운 문제입니다—가장 낮은 공통 분모인 독자를 위해 글을 쓰면, 대다수의 독자를 실망시키는 부담스럽고 지루한 책 같은 것이 될 가능성이 큽니다. 하지만 그 최하 수준으로 글을 쓰지 않으면, 해당 독자층을 잃게 됩니다. 어떻게 해야 할까요? 대부분의 작가들은 대다수의 독자를 겨냥하고 더 많은 도움이 필요한 소수의 독자를 희생합니다. 다른 작가들은 보충 정보를 부록에 넣거나 초보자용 책에 대한 교차 참조를 삽입합니다.
청중 분석 예시
기술 글쓰기 과정을 수강하고 있다면, 기술 문서에 청중 설명을 추가해야 할 수도 있습니다. 다음은 예시입니다:
| 강사에게 전달할 메시지: 이 지침은 매크로를 사용하여 Microsoft Excel을 통해 계산을 간소화하려는 개인을 위한 것입니다. 이들은 Microsoft Excel에 데이터를 입력하는 방법을 이해하고 있으며 Microsoft Office Suite에 대한 기본 지식을 가지고 있습니다. Windows 소프트웨어 사용에 익숙하고 기본적인 산술 능력을 가지고 있어 계산을 검증하고 논리 오류를 체크하는 데 편안합니다. |
청중 적응
알겠습니다! 그래서 당신은 청중을 분석하여 자신을 아는 것보다 그들을 더 잘 알게 되었습니다. 이게 무슨 소용이죠? 이 정보를 어떻게 활용하나요? 독자들에게 여전히 이해할 수 없거나 쓸모없는 글을 쓰지 않도록 어떻게 방지하나요?
글쓰기의 사업 에게 여러분의 청중은 타고난 재능, 직관, 심지어 신비와도 많이 관련이 있을 수 있습니다. 하지만 독자와 연결될 확률을 높이기 위해 사용할 수 있는 몇 가지 방법이 있습니다. 다음 "통제"는 주로 비전문가 청중을 위해 기술 정보를 보다 이해하기 쉽게 만드는 것과 관련이 있습니다:
- 독자가 문서를 이해하는 데 필요한 정보를 추가하십시오. 특정 중요한 정보가 누락되었는지 확인하십시오—예를 들어, 일련의 지침에서 중요한 단계; 초보자가 주요 논의를 이해하는 데 도움이 되는 중요한 배경; 주요 용어의 정의. (장 참조) 컨텐츠에 대한 아이디어 자세한 내용은.)
- 독자가 필요 없는 정보는 생략하세요. 불필요한 정보는 독자를 혼란스럽게 하고 짜증나게 할 수 있습니다—결국, 그들이 읽어야 한다고 느끼게 하기 위해 존재하는 것인데요. 예를 들어, 기본 지침에서 이론적인 논의를 잘라낼 수 있을 것입니다.
- 현재 가진 정보의 수준을 변경하세요. 올바른 정보를 가지고 있을 수도 있지만, 그 정보가 너무 높은 또는 낮은 기술 수준으로 "조정되어" 있을 수 있습니다. 잘못된 종류의 청중에게 맞춰져 있을 수도 있습니다—예를 들어, 기술자 청중이 아닌 전문가 청중에게 맞춰져 있을 수 있습니다. 이러한 일은 제품 디자인 노트가 지침으로 오해될 때 가장 자주 발생합니다.
- 예시를 추가하여 독자들이 이해할 수 있도록 도와주세요. 예시는 청중과 연결하는 가장 강력한 방법 중 하나이며, 특히 설명서에서 그렇습니다. 비설명서 텍스트에서도 마찬가지로, 예를 통해 기술 개념을 설명할 때 예시는 큰 도움이 됩니다—특히 비유적으로.
- 예시의 수준을 변경하세요. 예를 들어 설명할 수 있지만, 기술적인 내용이나 수준이 독자에게 적합하지 않을 수 있습니다. 일상적인 예는 전문가에게 유용하지 않을 수 있고, 매우 기술적인 예는 비전문가 독자에게 완전히 무의미할 수 있습니다.
- 정보의 구성을 변경하세요. 때때로, 모든 올바른 정보를 가질 수 있지만 잘못된 방식으로 배열할 수 있습니다. 예를 들어, 특정 독자가 길을 잃을 수 있을 만큼 배경 정보가 지나치게 많거나 (또는 너무 적게) 제공될 수 있습니다. 때때로, 배경 정보를 주요 정보—로 통합할 필요가 있습니다. 예를 들어, 지침에서는 필요할 때마다 배경 정보를 적절한 지점에서 제공하는 것이 더 나은 경우가 있습니다. (장을 참조하십시오) 구조 그리고 조직 문서의 정보입니다.)
- 전환을 강화하다. 독자들, 특히 비전문가들이 문서의 주요 섹션 간, 개별 단락 간, 때로는 개별 문장 간의 연결을 보는 데 어려움을 겪을 수 있습니다. 이러한 연결을 훨씬 더 명확하게 만들기 위해 추가할 수 있습니다. 전환어 그리고 메아리치며 키워드 더 정확하게. "따라서," "예를 들어," "그러나"는 전환 단어—이들은 이전 생각과 다음 생각을 연결하는 논리를 나타냅니다. 동일한 핵심 단어를 신중하게 반복함으로써 전환을 강화할 수도 있습니다. 기술 문헌에서는 이렇습니다. 아니다 단어 선택을 다양화하는 것은 좋은 생각이다—사람들이 이미 혼란스러워할 수 있는 같은 단어를 사용하지 않도록. (의 장을 참조하십시오) 전환.)
- 문서 전체와 주요 섹션을 위한 더 강력한 서론을 작성하십시오. 사람들은 전체 맥락을 이해하고 자신감을 가지고 읽는 것처럼 보이는데, 이는 "큰 그림"—미래의 상황과 방금 읽은 내용이 어떻게 관련되는지를 보여주기 때문입니다. 따라서 전체 문서에 대한 강력한 제목을 작성하십시오 —주제, 목적, 독자 및 내용이 명확히 전달되는 제목이어야 합니다. 그리고 문서 내의 각 주요 섹션에 대해 해당 섹션의 주제와 다룰 하위 주제에 대한 개요를 제공하는 미니 소개를 사용하십시오. (장 참조) 소개 전체 보고서와 보고서 내 섹션 모두에 대해.)
- 주제 문장을 작성하여 문단 및 문단 그룹을 만드세요. 독자들에게 주제와 섹션(단락 그룹)의 목적에 대한 아이디어를 제공하는 것이 매우 도움이 될 수 있으며, 특히 다룰 하위 주제에 대한 개요를 제공하는 것이 중요합니다. 로드맵은 당신이 다른 상태에 있을 때 도움이 됩니다! (해당 장을 참조하십시오) 개요와 주제 문장 사용하기.)
- 문장 스타일과 길이를 변경하세요. 어떻게 —를 개별 문장 수준에서 — 작성하는지가 큰 차이를 만들 수 있습니다. 예를 들어 지침에서 명령형 목소리와 "당신" 구문을 사용하는 것이 수동태나 3인칭 구문보다 이해하기 훨씬 쉽습니다. 어떤 이유에서인지, 개인화된 글쓰기 스타일을 만들고 더 편안하고 비공식적으로 만드는 것이 더 접근 가능하고 이해하기 쉽게 만들 수 있습니다. 수동적이고 사람 없는 글쓰기는 읽기가 더 어렵습니다 — 글에 사람과 행동을 담으세요. 유사하게, 능동적인 동사를 선택하세요. 있다 동사 구문. 이 모든 것이 당신의 글을 더 직접적이고 즉각적으로 만듭니다—독자들은 그것을 찾기 위해 파고들 필요가 없습니다. (챕터 참조) 일반적인 문장 스타일 문제 자세한 내용은.)
분명히, 문장 길이도 중요합니다. 문장당 평균 15에서 25 단어 사이가 적당하며, 30 단어가 넘는 문장은 신뢰할 수 없습니다. - 문장 명확성과 간결성을 개선하세요. 이것은 이전 "control"와 밀접하게 관련되어 있지만 독립적인 자리를 가질 가치가 있습니다. 종종, 글쓰기 스타일이 너무 장황하여 읽기가 어렵거나 짜증날 수 있습니다. 초안을 수정할 때는 초안을 다이어트시키세요 — 초안을 한 줄씩 살펴보며 전체 단어, 페이지 또는 줄 수를 20퍼센트 줄이도록 노력하세요. 실험으로 시도해 보세요, 결과가 어떨지 확인해 보세요. 불필요한 세부사항과 부풀려진 표현들이 많이 잘려 나갈 것입니다. (챕터를 참조하세요) 일반적인 문장 스타일과 명확성 문제 자세한 내용은 참고하십시오.)
- 더 많은 또는 다양한 그래픽을 사용하세요. 전문가가 아닌 청중을 위해서는 더 많은 그래픽—과 그보다 더 간단한 것들을 사용하는 것이 좋습니다. 전문가를 위한 그래픽은 더 자세하고, 더 기술적입니다. 비전문가를 위한 기술 문서에서는 "장식적인" 그래픽—이 더 많아지는 경향이 있으며, 이들은 매력적이지만 엄격한 정보 전달이나 설득의 목적은 전혀 없습니다. (챕터를 참조하십시오) 그래픽스 자세한 내용은.)
- 텍스트를 의미 있는 사용 가능한 청크로 나누거나 통합하세요. 전문가가 아닌 독자를 위해서는 짧은 단락이 필요할 수 있습니다. 보통 6~8줄의 단락이 일반적인 최대 길이입니다. 전문가를 위해 작성된 기술 문서에서는 단락이 얼마나 더 긴지 주목하세요.
- 중요한 정보에 교차 참조 추가하기. 기술 정보에서는 비전문 독자들이 배경 자료로 안내받을 수 있도록 도와줄 수 있습니다. 주제를 그 자리에서 완전히 설명할 수 없다면, 해당 주제가 포함된 섹션이나 장을 가리키십시오. (장 참조) 교차 참조 자세한 내용은.)
- 제목 및 목록 사용하기 - 제목 1 - 항목 1 - 항목 2 - 제목 2 - 항목 3 - 항목 4 독자들은 가끔씩 빈 줄 외에는 아무것도 없는 긴 밀집된 문단에 위축될 수 있습니다. 초안에서 제목을 삽입할 방법을 찾아보세요—주제나 하위 주제의 변화가 있는지 확인하세요. 목록 형식으로 나열된 내용이 있는지 살펴보세요—이것들은 수직 리스트로 만들어질 수 있습니다. 용어와 그 정의와 같은 쌍으로 나열된 내용을 찾아보세요—이들은 두 열 리스트로 만들 수 있습니다. 물론, 이러한 특별한 형식을 강제로 적용하지 않도록 주의하세요—과도하지 않도록 하세요. (장 참조) 제목 그리고 목록들 자세한 내용은 참조하십시오.)
- 특수 타이포그래피를 사용하고, 여백, 줄 길이, 줄 간격, 글꼴 크기 및 글꼴 스타일을 조정하세요. 전문가가 아닌 독자를 위해서는 여백을 줄여서 줄을 짧게 만들거나, 글자 크기를 키우는 등의 방법을 사용할 수 있습니다. 특정 글꼴 스타일이 다른 스타일보다 더 친근하고 읽기 쉽다고 여겨집니다. (글꼴에 대한 통찰을 얻으려면 출판에 관련된 사람을 찾아보세요.)
이것들은 전문 기술 작가들이 자신의 작업을 세밀하게 조정하고 가능한 한 쉽게 이해할 수 있도록 만드는 데 사용하는 "통제"의 종류입니다. 대조적으로, 이러한 영역에서의 많은 문제가—심지어 사소해 보이는 문제들—이 축적되어 문서를 읽고 이해하기 어렵게 만듭니다. 비전문가들은 종종 전문 작가와 편집자들이 왜 그렇게 사소하고, 변별력이 없는 세부 사항에 집착하는지 의문을 품습니다—하지만, 이 모든 것들이 쌓입니다! 이는 고대 중국의 처형 방법인 "천 cuts에 의한 죽음"을 생각나게 합니다. 그러나 이 경우, 그것은 "천 개의 사소한 문제로 인한 혼란"입니다.
상황 분석 및 발명
단순히 주제를 선택하고 기술 문서 프로젝트의 대상을 정의하는 것만으로는 충분하지 않습니다. 여러분은 (알거나 창조해야 하는) 상황 이 청중이 활동하는 맥락은 무엇이며—목표는 무엇인가: 문제를 해결하고, 개선을 가능하게 하며, 의사 결정을 지원하는가? 기술 문서 작성을 위한 상황은 아마도 인간의 사회적 관계만큼 무한할 것입니다. 기술 문서 상황은 특정 요구와 용도를 위한 특정 유형의 기술 문서를 필요로 하거나 요청하는 청중이 관련되어 있습니다. 자세한 내용은 다음을 참조하십시오. 상황 분석 및 발명
관련 정보
설문조사를 이용하여 청중 통찰력 발견하기. 브라이트톡
관객노스캐롤라이나 대학교 채플힐 캠퍼스
이 챕터에 대한 당신의 생각, 반응, 비판을 주시면 감사하겠습니다: 당신의 응답—데이비드 맥머리
