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