메모:
- 이 장과 이 기술 작문 교과서의 나머지 부분은 다음에 중점을 둡니다. 기술 문서 작성 능력. 여기의 기술적 내용은 성공적이거나 정확하거나 최신이 될 것이라고 보장되지 않습니다.
- 여기를 클릭하여 도와주세요. 데이비드 맥머리 웹 호스팅 기부: 가능한 금액을 기부해 주세요! 온라인 기술 작문은 계속 무료로 제공됩니다.
이 장의 초점은 모든 기술 작성의 가장 중요한 용도 중 하나인 — 설명서에 있습니다. 아시겠지만, 지침 그것은 무언가를 하는 방법에 대한 단계별 설명입니다: 만드는 방법, 운영하는 방법, 수리하는 방법 또는 유지보수하는 방법.
반드시 확인해 보세요. 예시들.
작업을 위한 지침 세트를 작성하거나 기술 작문 수업을 위한 것인가요? 그럼 이걸 시도해 보세요. 지침 계획 가이드.
작성 지침
기술 작성의 가장 일반적이며 가장 중요한 용도 중 하나는 지침입니다—사物을 조립하거나, 작동하거나, 수리하거나, 정기적으로 유지보수하는 방법에 대한 단계별 설명입니다. 그러나 이러한 것이 겉보기에 간단하고 직관적일지라도, 지침은 찾을 수 있는 가장 형편없는 문서 중 하나입니다. 나처럼, 당신도 아마 badly written instructions에 대한 많은 짜증나는 경험이 있었을 것입니다. 이 장에서 이어지는 내용은 지침 작성을 위한 완벽하고 실수 없는 가이드가 아닐 수 있지만, 전문가들이 고려하는 최고의 기법을 보여줄 것입니다.
궁극적으로 좋은 안내서 작성은 다음을 요구합니다:
- 명확하고 간결한 글쓰기
- 모든 기술적 세부 사항에 대한 절차에 대한 철저한 이해
- 독자의 입장에서 생각할 수 있는 능력, 즉 당신의 지침을 사용하려는 사람의 입장에 서는 능력
- 절차를 세밀하게 시각화하고 그 인식 내용을 종이에 담아낼 수 있는 능력
- 결국, 당신이 그 추가 거리를 가고, 당신이 그를 위해 쓴 지침을 그 사람에게 시험해 보려는 의지가 중요합니다.
지금쯤이면 제목, 목록, 그리고 특별한 공지사항에 대해 공부했을 것입니다. 이러한 도구를 사용하여 일련의 지침을 작성하는 것이 아마도 명백하게 보일 것입니다. 그냥 논의를 번호가 매겨진 수직 목록으로 나누고 명백한 지점에 특별한 공지사항을 넣으면 끝입니다! 음, 그렇지 않지만, 좋은 시작입니다. 이 챕터에서는 지침을 더 복잡하게 만들 수 있는 몇 가지 기능을 탐구합니다. 이러한 고려사항을 사용하여 자신의 지침을 계획할 수 있습니다.
이 장의 NotebookLM 생성 인포그래픽
일부 준비 사항
프로젝트를 시작할 때, 작성할 지침의 구조나 특성을 결정하는 것이 중요합니다.
청중과 상황. 과정 초기에, 당신의 지침의 청중과 상황을 정의하세요. 청중을 정의하는 것은 주제에 대한 친숙도와 다른 세부 사항을 정의하는 것을 의미한다는 점을 기억하세요. 논의 내용을 참고하세요. 청중 청중을 정의하는 데 사용할 단계입니다.
가장 중요한 것은, 만약 당신이 작문 수업에 있다면, 당신의 청중에 대한 설명을 작성하고 그것을 당신의 지침에 첨부해야 한다는 것입니다. 이는 당신의 강사가 의도된 청중에 대한 지침의 적합성을 평가할 수 있도록 해 줄 것입니다. 또한 기술 작문 수업에서는 비전문가 청중을 위해 쓰는 것이 더 바람직하다는 것을 기억하세요. 이는 작가로서 당신에게 훨씬 더 도전이 될 것입니다.
작업의 수. 당신이 쓰고 있는 절차에는 몇 개의 작업이 있습니까? 용어를 사용해 봅시다. 절차 귀하의 지침이 논의하고자 하는 전체 활동 세트를 지칭합니다. A 작업 주어진 절차 내에서 반자율적인 행동 그룹입니다: 예를 들어, 전자레인지의 시계를 설정하는 것은 전자레인지를 작동하는 큰 전체 절차 내의 하나의 작업입니다.
자동차의 오일 교환과 같은 간단한 절차는 단 하나의 작업만 포함되어 있으며, 반독립적인 활동 그룹이 없습니다. 전자레인지 사용과 같은 더 복잡한 절차에는 시계 설정, 전원 수준 설정, 타이머 사용, 전자레인지 청소 및 유지 관리 등 여러 반독립적인 작업이 포함되어 있습니다. (그들 중 일부) 카메라 사용 안내 작업별로 조직되어 있습니다.)
어떤 지침은 단일 작업만 있지만, 그 단일 작업 내에 많은 단계가 있습니다. 예를 들어, 어린이 그네 세트를 조립하는 지침 세트를 상상해 보세요. 제 경험상 130단계 이상이 있었습니다! 그것은 다소 압도적일 수 있습니다. 좋은 접근 방법은 유사하고 관련된 단계를 단계로 그룹화하고 각 새로운 단계에서 단계 번호를 다시 매기는 것입니다. A 상태 그렇다면 단일 작업 절차 내에서 유사한 단계의 그룹입니다. 그네 세트의 예에서, 프레임을 설치하는 것은 한 단계가 될 것이고; 물건을 땅에 고정하는 것은 또 다른 단계가 될 것이며; 박스 그네를 조립하는 것은 또 다른 단계가 될 것입니다.
작업 지향성을 사용하세요. 독자들이 수행하고 싶어하는 작업에 집중하고, 제목에는 '어떻게' 또는 –ing 문구를 사용하세요.
단계별 논의에 대한 최선의 접근법. 또 다른 고려사항은, 아마 초기에는 결정할 수 없을 수도 있는, 당신의 지침을 어떻게 집중할 것인가입니다. 대부분의 지침에서, 당신은 작업에 집중할 수도 있고, 도구(또는 도구의 기능)에 집중할 수도 있습니다.
In a 작업 접근법 (작업 지향이라고도 알려진) 전화 응답 서비스 사용에 대한 지침에는 다음과 같은 섹션이 포함됩니다:
- 인사말 녹음하기
- 메시지를 재생하고 있습니다.
- 메시지를 저장하는 중입니다.
- 메시지를 전달합니다.
- 메시지를 삭제하는 것, 등등
이것들은 기계로 하고 싶어 하는 전형적인 작업들입니다. 추가 논의는 — 장에서 확인하세요. 작업 분석.
반면에, 도구 접근법 복사기 사용 지침에는 다음과 같은 가능성이 낮은 섹션이 있을 것입니다:
- 복사 버튼
- 취소 버튼
- 확대/축소 버튼
- 집합/스테이플 버튼
- 복사 크기 버튼 등.
이 계획에 대한 지침을 설계한다면, 복사기의 각 버튼이나 기능을 사용하는 단계들을 작성할 것입니다. 이러한 도구 접근 방식을 사용한 지침은 작동하기 어렵습니다. 때때로 버튼의 이름이 그것이 연결된 작업과 잘 맞지 않거나, 작업을 수행하기 위해 단 하나의 버튼 이상을 사용해야 할 때도 있습니다. 그럼에도 불구하고 도구/기능 접근 방식이 더 바람직한 경우도 있을 수 있습니다.
작업 그룹화. 작업 목록을 만드는 것만으로는 충분하지 않을 수 있습니다. 너무 많은 작업이 있을 경우, 독자가 개별 작업을 더 쉽게 찾을 수 있도록 그룹화해야 할 수 있습니다. 예를 들어, 다음은 지침에서 흔히 사용되는 작업 그룹입니다:
- 개봉 및 설치 작업
- 작업 설치 및 사용자 지정
- 기본 운영 작업
- 정기적인 유지보수 작업
- 문제 해결 작업; 기타 등등
지침의 일반적인 섹션
다음은 설명서에서 흔히 볼 수 있는 섹션에 대한 리뷰입니다. 각 섹션이 모두 포함되어 있다고 가정하지 마세요. 해야 한다 실제 작성하는 지침에 포함되어야 하거나, 여기 제시된 순서대로 배치되어야 하거나, 이들이 지침 세트에서 가능한 유일한 섹션이라는 것은 아닙니다.
다음의 일반적인 섹션을 읽으면서 지침에서 확인해 보세요. 예시 지침.
지침의 개략적 보기. 이것은 내용과 조직을 위한 전형적이거나 일반적인 모델임을 기억하세요. 많은 다른 모델도 가능합니다.
소개. 지침의 서두를 신중하게 계획하세요. 다음 중 귀하의 특정 지침에 해당하는 사항들을 확인하세요 (단, 반드시 이 순서로 할 필요는 없습니다):
- 특정 작업이나 절차를 설명해야 할 내용과 범위(무엇)를 명시하십시오. 않을 거예요 덮여질 수 있습니다).
- 청중이 지침을 이해하기 위해 필요한 지식과 배경을 명시하세요.
- 절차의 일반적인 개요와 그것이 무엇을 달성하는지 설명하세요.
- 이 지침을 사용해야 하는 조건 (또는 사용해서는 안 되는 조건)을 나타내십시오.
- 지침의 내용에 대한 개요를 제공하십시오.
해당 섹션을 참조하세요. 소개 더 많은 논의를 위해.
일반 경고, 주의, 위험 고지. 사용자에게 장비가 손상될 가능성, 절차가 잘못될 가능성, 그리고 자신이 다칠 가능성을 경고해야 하는 경우가 자주 있습니다. 또한, 지침에서는 주요 사항이나 예외를 강조해야 하는 경우도 많습니다. 이러한 상황을 위해 사용합니다. 특별 공지사항—노트, 경고, 주의, 위험 안내문. 위에 나열된 예시 지침에서 이러한 특별 안내문이 어떻게 사용되는지 주목하세요.
기술적 배경 또는 이론. 특정 유형의 지침 시작 부분(물론 서론 이후)에 절차와 관련된 배경에 대한 논의가 필요할 수 있습니다. 특정 지침의 경우, 이 배경은 매우 중요합니다—그렇지 않으면 절차의 단계가 의미가 없습니다. 예를 들어, 빨간색, 초록색, 파란색 슬라이더 바를 조정하여 자신의 색상을 정의하는 소프트웨어 애플릿에 대한 경험이 있을 수 있습니다. 자신이 하고 있는 일을 진정으로 이해하기 위해서는 색상에 대한 배경이 필요합니다. 마찬가지로, 카메라를 사용하는 특정 지침의 경우, 이론이 필요할 수도 있다고 상상해볼 수 있습니다.
장비 및 용품. 절차를 시작하기 전에 모아야 할 것들의 목록이 대부분의 지침에 포함되어 있는지 확인하세요. 여기에는 장비절차에서 사용하는 도구들(예: 믹싱 볼, 숟가락, 빵 팬, 망치, 드릴, 그리고 톱) 및 공급품절차에서 소비되는 것들(예: 목재, 페인트, 기름, 밀가루, 못 등). 지침에서는 일반적으로 간단한 수직 목록이나 두 개의 열 목록으로 나열됩니다. 항목의 일부 또는 전체에 브랜드 이름, 크기, 양, 유형, 모델 번호 등을 추가해야 하는 경우에는 두 개의 열 목록을 사용하십시오.
단계에 대한 논의. 단계를 실제로 작성할 때 염두에 두어야 할 몇 가지 사항이 있습니다: (1) 단계의 구조와 형식, (2) 필요할 수 있는 보충 정보, (3) 관점과 일반적인 글쓰기 스타일.
구조 및 형식. 일반적으로, 우리는 지침 세트를 세로 번호 리스트 형식으로 상상합니다. 그리고 대부분이 실제로 그렇습니다. 일반적으로, 당신은 실제 단계별 지침을 이렇게 포맷합니다. 그러나 몇 가지 변형과 다른 고려 사항도 있습니다:
- 정해진 순서 단계 는 제시된 순서대로 수행해야 하는 단계입니다. 예를 들어, 자동차의 엔진 오일을 갈고 있다면, 오일을 빼는 것은 한 단계입니다. 필수적이다 새 기름을 넣기 전에 앞서. 다음은 번호가 매겨진 목록입니다(보통 세로로 번호가 매겨진 목록).
- 변수 순서 단계 일반적으로 어떤 순서로든 수행할 수 있는 단계입니다. 좋은 예는 무언가를 고치려 할 때 체크해야 할 항목들을 알려주는 문제 해결 가이드입니다. 이러한 종류의 단계는 거의 모든 순서로 수행할 수 있습니다. 이 유형의 경우, 글머리 기호 목록이 적합한 형식입니다.
- 대체 단계 둘 이상의 방법으로 동일한 작업을 수행하는 경우입니다. 다양한 조건이 존재할 수 있을 때도 대체 단계가 사용됩니다. 이 유형에는 불렛 목록을 사용하고, 대안 사이에 OR을 삽입하거나 대안이 곧 제시될 것임을 나타내는 도입구를 사용하십시오.
- 중첩 단계. 어떤 경우에는 절차 내의 개별 단계가 그 자체로 상당히 복잡할 수 있으며, 하위 단계로 나누어져야 할 필요가 있습니다. 이 경우, 추가로 들여쓰기를 하여 하위 단계를 a, b, c 등으로 순서대로 나열합니다.
- "무단계" 안내서. 그리고 마지막으로, 번호가 매겨진 수직 목록을 실제로 사용할 수 없는 지침이 존재하며, 독자를 직접적으로 지시하는 것이 거의 없는 경우도 있습니다. 어떤 상황은 너무 일반적이거나 너무 가변적이어서 단계를 명시할 수 없습니다.
장에 대해 참조하세요. 목록들 이 가능성의 스타일과 형식을 위해.
보충 논의. 종종 독자들에게 이 행동을 하라고 말하는 것만으로는 충분하지 않습니다. 그들은 그 단계 이전과 이후의 모습, 이 단계를 수행해야 하는 이유, 그들이 하고 있는 일 뒤에 있는 기계적 원리, 심지어 그 단계를 구성하는 구체적인 행동에 대한 더 미시적인 설명 등 추가적인 설명 정보를 필요로 합니다.
하지만 보충 설명의 문제는 실제 단계를 감출 수 있다는 것입니다. 독자가 취해야 할 구체적인 행동인 실제 단계—가 돋보이게 하고 싶습니다—. 모든 것이 많은 단어 속에 묻히지 않기를 바랍니다. 이 문제를 피할 수 있는 기술은 최소한 두 가지가 있습니다: 지침과 보충 설명을 별도의 단락으로 나누거나, 지침을 굵게 표시하는 것입니다.
지침에서 실제 사용자 단계를 굵게 표시하기. 강조된 텍스트는 실제 행동과 보조 정보를 구분하는 데 도움을 줍니다.
전신식 글쓰기를 피하세요—"이해된" 관사(정관사, 부정관사)를 생략하는 것은. 맞아요, 로봇은 그렇게 쓰지만, 우리는 그럴 필요 없어요.
글쓰기 스타일. 실제로 지침을 문장별로 작성하는 방식은 이전의 글쓰기 수업에서 배운 것과 모순되는 것처럼 보일 수 있습니다. 그러나 실제 세계의 지침이 어떻게 작성되는지 주목해 보세요. 많은 명령어(명령형 또는 직접 주소 지정) 스타일의 글쓰기를 사용하며, 많은 "당신"이라는 단어를 사용합니다. 이는 전혀 적절합니다. 독자의 시선에 직접 들어가, 그녀나 그의 온전한 주의를 끌고 싶기 때문입니다. 이러한 이유로 지침 스타일의 문장은 다음과 같이 들립니다: 지금, 디스플레이를 일시 중지하려면 전면 패널의 일시 중지 버튼을 눌러주세요. 그리고 조심해야 할 점은...
특정 문제는 지침에서 수동형 사용과 관련이 있습니다. 이상하게도, 일부 지침은 이렇게 들립니다: " 일시정지 버튼은 디스플레이를 일시적으로 멈추기 위해 눌러져야 합니다." 우리는 일시정지 버튼의 정신 건강에 대해 걱정할 뿐만 아니라, 누가 이 버튼을 눌러야 하는지를 궁금해합니다 (저한테 말씀하시는 건가요?). 또는 다음 예를 생각해 보십시오: " 타이머 버튼은 3:00으로 설정됩니다." 다시 말해, 이 지침을 따르는 사람으로서 당신은 이것을 놓칠 수 있습니다; 단순히 어떤 기존 상태를 지칭하는 것이라고 생각할 수도 있고, 아니면 궁금해할 수 있습니다, " 저한테 말씀하시는 건가요?" 거의 똑같이 나쁜 것은 제삼자 사용입니다: " 사용자는 그 다음 일시정지 버튼을 눌러야 합니다." 다시 말해, 낯선 사람처럼 주위를 둘러보며 궁금해할 수 있습니다, " 저요?" (자세한 내용은 참조하십시오) 수동태 문제.)
지침에서 쓰기 스타일과 관련된 또 다른 전형적인 문제는 사람들이 관사를 생략하려는 경향이 있다는 것입니다: "전면 패널의 일시 정지 버튼을 눌러 정보를 임시로 중단하세요" 또는 "지구인, 가장 가까운 피자 레스토랑의 주소를 제공해 주세요." 왜 우리는 이렇게 할까요? 우리 모두 비밀리에 로봇이 되고 싶어하나요? 어쨌든 모든 관사를 포함하는 것을 잊지 마세요 (a, 안, 그) 및 지침에서 일반적으로 사용할 단어와 같은 다른 단어들.
지침의 그래픽
아마도 다른 어떤 글쓰기 형식보다도 (만화책을 제외하고) 그래픽은 지침서에서 결정적입니다. 때로는 글로는 그 단계를 설명할 수 없습니다. 일러스트는 독자들이 해야 할 일을 시각화하는 데 종종 중요합니다.
기술 작문 수업에서는 지침에 일러스트레이션이나 기타 그래픽 유형을 포함해야 할 수 있습니다—일반적으로 지침에 사용되는 모든 내용. 물론 문제는 특정 지침에 적합한 그래픽에 접근할 수 없고, 자신의 예술적 능력에 대한 자신감이 부족할 수 있다는 것입니다. 이러한 문제를 극복할 방법이 있습니다! 제안 사항을 살펴보세요. 그래픽스그 장에서는 그래픽을 만드는 제안뿐만 아니라 형식에 대한 요구사항도 보게 될 것입니다.
지침 형식
제목. 지침에서 제목을 잘 활용하세요. 일반적으로, 배경 섹션에 대한 제목, 장비 및 용품 섹션에 대한 제목, 실제 지침 섹션에 대한 일반 제목, 그리고 그 섹션 내의 개별 작업이나 단계에 대한 부제목을 원합니다. 이 장의 시작 부분에 있는 예를 참고하세요. 머리글 공통 요구 사항에 대해.
목록. 마찬가지로, 지침은 일반적으로 목록을 많이 사용하며, 특히 실제 단계별 설명을 위한 번호 매긴 수직 목록을 많이 활용합니다. 간단한 수직 목록이나 두 열 목록은 보통 장비 및 용품 섹션에 적합합니다. 문장 내 목록은 앞으로 다룰 내용의 개요를 제공할 때 좋습니다. 목록 공통 요구 사항에 대해.
특별 공지사항. 지침에서는 독자에게 장비를 손상시키거나, 자원을 낭비하거나, 전체 절차가 실패하게 하거나, 자신이나 타인에게 부상을 입히는 가능성에 대해 경고해야 합니다—심각하게 또는 치명적으로. 기업들은 이러한 특별 안내의 부족, 잘못 작성된 특별 안내, 혹은 부적절한 특별 안내로 인해 고소당한 사례들이 있습니다. 보세요. 특별 공지 사항 이 특별 통지를 적절하게 사용하는 방법과 형식, 지침 내 배치에 대한 완전한 논의를 위해.
숫자, 약어 및 기호. 지침에는 많은 숫자, 약어 및 기호도 사용됩니다. 위해 지침 이 분야에 대해.
지침의 공지 들여쓰기. 첫 번째 예시에서, 공지가 어떻게 들여쓰기 되어 있는지 주목하세요. 텍스트 이전 단계의. 두 번째 예에서, 심각한 공지가 모든 단계 전에 처음에 배치되어 있다는 점에 주목하십시오.
AI 프롬프트를 위한 지침
일반적으로 읽히지 않는 체크리스트는 약간의 수정을 통해 AI 프롬프트의 출처로 사용될 수 있습니다. 다음 내용을 복사하여 Google의 Gemini와 같은 AI 시스템에 붙여넣고 놓친 것이 무엇인지 확인해 보세요.
참고: 콘텐츠, 형식, 스타일 지침 또는 그 구성 요소에 대한 모든 참조는 다음에서 찾을 수 있습니다. 온라인 기술 작문 교과서.
AI를 사용하여 글쓰기 프로젝트를 평가하고 싶을 때, 자신을 소개하고 AI에게 자신이 누구인지, 원하는 것이 무엇인지 말하세요. AI가 평가를 할 수 있도록 온라인 교과서와 같은 기준점을 제공하세요. 그런 다음 AI에게 평가에서 확인해주길 원하는 내용을 게시하세요.
자신의 정체성에 맞게 소개문을 수정하세요.
|
AI 프롬프트 지침 안녕하세요, AI. 미국 대학 2학년이 작성한 지침을 평가해 주시기 바랍니다. 아래는 교과서 장의 요약입니다. 지침 그리고 공지사항 평가의 기초로 사용할 수 있습니다. (식별 정보가 마스킹됨):
|
관련 정보
독서 퀴즈. 이 퀴즈를 사용하여 이 챕터에 대한 이해도를 시험해 보세요.
지침 작성 방법. 테크스크라이브
이 장에 대한 당신의 생각, 반응, 비판을 부탁드립니다. 당신의 응답—데이비드 맥머리.
