여기를 클릭하여 도와주세요. 데이비드 맥머리 웹 호스팅 비용 지급:
작은 금액이라도 기부해 주세요!
온라인 기술 작문은 계속 무료입니다.

지침, 절차 및 "가이드" 또는 사용자 가이드 정보를 작성할 때, 일반적으로 작업 접근 방식을 사용해야 합니다. 즉, 사용자가 수행해야 할 모든 주요 작업 분석에 대한 단계와 설명을 제공해야 한다는 뜻입니다.

물론 일부 지침은 단일 작업—만 포함합니다, 예를 들어 자동차의 오일을 교체하는 것입니다. 그러나 우리는 여기에서 더 복잡한 절차에 대해 다루고 있습니다. 이 장에서는 컴퓨터 소프트웨어를 예로 사용하지만, 이러한 기술은 어떤 다중 작업 절차—에도 적용될 수 있습니다, 예를 들어 전자 레인지를 작동하는 것입니다.

NotebookLM-generated infographic of this chapter

업무 식별

작업 지향적으로 글을 쓰려면 먼저 작업 분석을 해야 합니다. 이는 사용자들이 제품을 사용하거나 작업을 수행하는 방식을 연구하고, 그들과 인터뷰하며, 그들을 지켜보는 것을 의미합니다. 마케팅 및 제품 개발 담당자들을 인터뷰하는 것도 포함될 수 있습니다. 헬프 데스크 직원들이 받는 질문 종류를 얻을 수 있다면 그것도 도움이 됩니다.

하지만 때때로, 철저한 작업 분석을 할 위치에 있지 않을 수 있습니다. 일반적으로 제품 개발자는 문서화에 대해 꽤 늦게 생각합니다. 이러한 상황에서는 마케팅, 개발, 엔지니어링, 프로그래밍 사람들이 충분한 시간을 들여 당신과 함께 제품을 설명하는 것이 어렵습니다. 그래서 결국 어느 정도의 추측 작업을 하게 됩니다. 개발자는 당신의 초안을 검토하고 당신의 추측이 맞는지 알려줄 가능성이 더 높습니다.

자신만의 작업 분석을 개발하기 위해, 제품의 사용자 인터페이스(버튼, 메뉴, 옵션 등)를 연구할 수 있습니다. 이는 하드웨어와 소프트웨어 모두에 해당됩니다. 아래에 보여지는 아이콘 편집 도구의 인터페이스를 고려해 보십시오. 이 인터페이스의 일부분만으로도 여러 가지 명백한 작업 분석 항목을 식별할 수 있습니다: New, Open, Save As, Exit:

  1. 새 아이콘 프로젝트 시작하기
  2. 기존 아이콘 프로젝트를 열어 편집하기
  3. 아이콘 프로젝트 이름 변경 (다른 이름으로 저장)
  4. AZ 아이콘 편집 종료

AZ 아이콘 편집 인터페이스

이제 메뉴의 다음 부분에 대한 메뉴 옵션을 살펴보세요. 사람들이 이 아이콘 편집기를 사용할 때, 이 작업 분석을 수행할 가능성이 높다는 것을 알 수 있습니다.

  1. 실수를 되돌리다
  2. 이미지를 캡처하거나 그 일부를 캡처하세요.
  3. 아이콘 프로젝트에서 무언가를 잘라내기
  4. 아이콘 프로젝트에서 무언가를 복사하다.
  5. 아이콘 프로젝트에 무언가를 붙여넣기
  6. 이미지를 수평 또는 수직으로 전체 뒤집으세요.
  7. 이미지를 왼쪽으로 회전하세요.
  8. 프로젝트를 지우세요, 아마도 다시 시작하라는 의미일 것입니다.
  9. 복원, 당신이 알아내기 위해 여기저기 물어보거나, 실험해 보거나, 프로그래밍 사양을 자세히 살펴봐야 할 것입니다.
  10. 두껍거나 중간, 또는 얇은 선으로 그리세요.

하지만 이제 메뉴 옵션이 드롭다운되지 않은 인터페이스를 봅시다. 어떤 추가 작업_분석을 볼 수 있습니까? 많은 그래픽 사용자 인터페이스와 마찬가지로, 일부 아이콘은 메뉴 옵션을 중복합니다. 예를 들어, 글머리 아이콘을 클릭하는 것과 같은 방식으로 얇은 선, 중간 선 또는 두꺼운 선을 선택할 수 있습니다. 옵션 하지만 여기에는 인터페이스의 다른 곳에서는 사용할 수 없는 몇 가지 새로운 도구가 있습니다.

  1. 직선을 그리세요 (두 개의 연필 아이콘 사이의 차이를 보기 위해 실험해 보아야 합니다)
  2. 자유 곡선을 그리세요 (물결선 아이콘)
  3. 빈 사각형을 그리세요 (날카로운 모서리) 그리고 빈 사각형을 그리세요 (둥근 모서리)
  4. 빈 타원과 채워진 타원을 그리세요.
  5. 색을 칠하세요 (주사기 바늘)
  6. 이미지에서 이동, 잘르거나 회전할 부분을 선택하세요 (점선 아이콘)
  7. 이미지를 캡처—하거나 이미지의 일부—를 캡처합니다(네트, 하지만 어떻게 작동하나요?)
  8. 채워진 직사각형(날카로운 모서리)과 채워진 직사각형(둥근 모서리)을 그립니다.
  9. 배경 색상 선택 (스크린 버튼)
  10. 선 또는 채우기 색상 선택 (두 개의 상자 아이콘)

이 소프트웨어에 대해 아직 모르는 것이 많지만, 주요 작업 분석을 정의하는 데 많은 추측을 해 보았습니다. 위보다 훨씬 더 세분화하고 통합하고 싶을 것입니다. 아마 다음과 같이:

이 이rough 작업 목록에서 객체에 색을 채우기, 이미지 캡처, 작업공간 정리, 실수 되돌리기, 복원과 같은 task_analysis의 흔적이 없다는 것을 알 수 있습니다. 하지만 작업을 진행하면서 이러한 세부 사항들이 여러분의 계획에 자리잡기 시작할 것입니다. 이제 인터페이스의 세부 사항에서 한 걸음 물러나 아이콘 소프트웨어 사용자의 입장이 되어 보세요. 그 개인이 어떤 질문을 할 가능성이 높을까요? 배경 색상을 어떻게 변경하나요? 그건 해결했습니다. 내가 그리는 선의 두께를 어떻게 변경하나요? 그것도 해결했습니다. 배경을 투명하게 만들려면 어떻게 하나요? 흠... 그건 색상 섹션의 문제일 것이지만, 약간의 연구가 필요할 것입니다.

문서화에 대한 다양한 접근 방식

사용자를 위해 글을 쓸 때, 두 가지 접근 방식 중에서 선택할 수 있습니다. 함수 방향 그리고 작업 지향성후者가 훨씬 더 나은 선택이다.

함수 지향적으로 쓰기. 작업 분석 후 진행 방법이 분명해야 하지만, 그게 아닌 것 같다. 컴퓨터 출판물—기술 출판물 일반—은 종종 비작업 지향적인 글쓰기 스타일로 벗어나는 경향이 있다. 하지만, 아니다! 그건 전혀 효과가 없다!

일부 사용자 가이드 지침이 작업 중심이 아닌 또 다른 이유는 제품 사양에 기인할 수 있습니다. 제품 사양은 프로그래머, 엔지니어, 개발자를 위해 작성되며, 요구되는 기능 측면에서 작성됩니다:

파일 메뉴 버튼 사용자가 새 파일을 만들고, 기존 파일을 열고, 파일의 이름을 바꾸는 등의 작업을 할 수 있도록 합니다.
자르기 아이콘 사용자가 선택한 이미지의 일부를 자를 수 있게 합니다.

이 접근 방식을 이렇게 부를 수 있습니다. 함수 지향 제품의 각 기능, 특징 또는 인터페이스 요소를 체계적으로 설명하기 때문에 이렇게 작성하고 있습니다. 불행히도 이러한 접근 방식은 비기술 독자를 위한 사용자 가이드에서 나타납니다. 아마도 이는 작가들이 경험이 부족하거나 훈련받지 않았거나 비기술적이어서일 것입니다. 아니면 작가들이 개발자의 사양을 다듬는 것 외에는 할 수 있는 일이 거의 없게 늦게 호출되었기 때문일 지도 모릅니다.

기능 중심 접근법은 가끔 거의 작동합니다. 그러나 "거의"와 "가끔"은 충분하지 않습니다. 거의 작동하는 이유는 인터페이스 요소와 함수의 이름이 지원하는 작업 분석과 가끔 일치하기 때문입니다. 예를 들어, 열림 메뉴 옵션은 꽤 직관적입니다: 기존 파일 열기. 다른 것들은 그렇지 않습니다. 예를 들어, 복원되는 것은 무엇이라고 생각하십니까? 복원하다 AZ 아이콘 편집 인터페이스의 버튼인가요? 또한 일부 인터페이스 요소는 스스로 작업을 수행하지 않습니다. 예를 들어, 포토샵에서는 텍스트를 잘라내기 위해 버튼을 누를 수 없습니다. 작물 메뉴 옵션. 먼저 텍스트 선택 버튼을 클릭한 다음, 유지하려는 이미지 부분 주위에 선택 상자를 그린 후, 눌러야 합니다. 자르기 버튼.

작업 중심으로 글쓰기.기능 중심 접근 방식 대신 작업 중심 접근 방식을 사용하세요. 사용자가 제품과 함께 수행해야 할 작업 분석을 식별한 후, 그에 맞게 문서를 구조화하세요. 제목 및 부제목을 만드세요. 작업 지향적인 그들의 표현에서. 작업 지향적 표현이란 "볼륨 조절하기," "볼륨 조정," 또는 "볼륨을 조절하라"와 같은 표현을 의미합니다. "볼륨"이나 "볼륨 조정"과 같은 표현은 포함되지 않습니다. 여기 몇 가지 추가 예시가 있습니다:

문제 진술 작업 지향적 문구
획득하다 이미지 캡처하기
스크린 버튼 배경 또는 전경 객체 선택하기
직사각형 사각형 그리기
타원형 아이콘 타원과 원 그리기

사용자 작업 분석을 정의하고, 이를 논리적 그룹으로 정리하며, 작업 중심의 제목을 정의했다면, 이제 글을 쓸 준비가 되었습니다! 다음은 발췌한 내용입니다:

사각형 및 타원 그리기

아이콘 편집기를 사용하여 사각형, 직사각형, 타원 및 원을 그릴 수 있습니다.

직사각형을 그리세요. 사각형을 그리려면:
  1. 원하는 전경색을 선택했는지 확인하세요. ( "전경색 선택하기" 참고.)
  2. 사각형 아이콘을 클릭하세요.
  3. 마우스 포인터를 사각형이 나타나길 원하는 도면 영역에 위치시키고, 왼쪽 마우스 버튼을 누른 채로 드래그하여 사각형을 만드세요.
타원을 그리세요. 타원을 그리려면:
  1. 확실히 . . .

이 발췌에서는 전반적으로 작업 지향적인 접근 방식이 취해지고 있고, 제목에 작업 지향적인 표현이 사용되고 있음을 알 수 있습니다.그림 그리기). 독자들이 작업에 관련된 작업을 단계별로 따를 수 있도록 번호가 매겨진 목록이 사용된다는 점도 주목하십시오.

관련 정보

과제 기반 작문. WTD

이 장에 대한 당신의 생각, 반응, 비평을 듣고 싶습니다: 당신의 응답.