콘텐츠
- 독자의 입장이 되어라
- 독자에 대해 이해하기 위해 필요한 것
- 독자들은 이미 좌절하고 있습니다
- 지침 작성을 시작하기 전 참고 사항
- 쓰기 지침에 대한 마법의 공식
- 마법의 공식 : 주어진 새로운 방법
- 이제 좋은 지침을 작성할 준비가되었습니다.
- 최종 정리
- 사용성 테스트 지침
- 결론 및 일반화
Laura는 기술 작가입니다. 그녀는 피아노 연주, 여행, 미술, 보석 만들기를 즐깁니다.
독자의 입장이 되어라
더 나은 컴퓨터 "방법"지침이나 절차를 작성하려면 먼저 독자 또는 사용자의 입장에서 생각해야합니다.
사용자는 귀하의 웹 사이트 나 소프트웨어에 대해 전혀 알지 못하며 작업을 시작하기 전에 전체 지침 세트를 읽는 데 시간을 할애하지 않을 것입니다. 사용자는 단순히 제품을 사용하여 자신의 일부 목표 (구매, 정보 조회 등)를 달성합니다.
독자에 대해 이해하기 위해 필요한 것
먼저 첫 번째 것들. 독자들은 당신이 쓴 것을 읽고 싶어하지 않을 가능성이 높다는 사실을 받아 들여야합니다. 즉, 효과적이고 유용한 지침을 작성하려면 먼저 다음 진리를 모두 받아 들여야합니다.
- 독자 / 사용자는 제품 / 서비스 사용 방법을 배우고 싶어하지 않습니다. 그들은 자신의 작업이나 목표를 달성하기를 원합니다.
- 그들은 시도한 것이 실패한 후 절망적으로 문서를 읽었습니다.
- 그들은 이제 좌절하고 있습니다.
- 목표 / 과업을 완료하기 위해 진행하는 방법에 대해 잃어버린다.
독자들은 이미 좌절하고 있습니다
지침 작성자는 사용자 (아마도 모르고 만나지 않을 것)가 작성한 지침을 볼 때 이미 제품 / 서비스에 불만을 느끼기 때문에 나쁜 상황에서 시작하고 있습니다. 각 작업을 수행하는 방법. 따라서 그들에게 친절하고 명확하고 간결하며 명확하고 정확한 지침을 제공하여 가능한 한 빨리 목표를 달성 할 수 있도록 도와줍니다. 이는 좋은 고객 서비스의 한 형태입니다!
이 패턴은 매우 쉽고 컴퓨터 지침뿐만 아니라 대부분의 단계별 지침에 적용 할 수 있습니다.
지침 작성을 시작하기 전 참고 사항
지침 작성을 시작하기 전에 작성해야하는 스타일을 알아야합니다.
"하우스 스타일 가이드"(마케팅 부서에서 시작하는 것이 좋습니다)를 요청하고 Microsoft 기술 간행물 스타일 매뉴얼의 최신 사본을 받으십시오.하지만 Apple Macintosh 사용자는 어떻습니까? 그들은 이미 마이크로 소프트의 글쓰기 스타일에 익숙하거나 여러분이 사용 설명서 전체에서 일관되게 글쓰기 스타일을 구현할 것이기 때문에 혼동하지 않을 것입니다.
사전과 동의어 사전은 인터넷에서 찾을 수 있지만 어떤 사전과 동의어 사전도 문제가되지 않으며 어떤 것을 사용할지 House Style Guide에 지정해야합니다. 확실하지 않은 경우 사전의 "골드 표준"인 Merriam Webster를 사용하십시오.
쓰기 지침에 대한 마법의 공식
| 내가 어디 있지? | 어떻게해야합니까? | 어떻게 된 거예요? |
|---|---|---|
독자에게 그들이 어디에 있는지 말하십시오 → | 무엇을해야하는지 알려주세요 → | 그들의 행동의 결과를 설명하십시오 |
마법의 공식 : 주어진 새로운 방법
이제 전문 작가 든 아니든 기술 커뮤니케이션의 기본 사항 중 하나를 알게되었습니다. 독자에게 이미 알고있는 "주어진"것을 말하면서 시작한 다음 "새로운"것을 제공하기 때문에 주어진 새로운 방법이라고도합니다. 명확한 제목 / 제목이 여기서 성공의 열쇠입니다.
이 방법은 이미 실망한 독자 / 사용자가 특정 절차가 자신의 상황에 적용되는지 여부, 올바른 시작 위치에 있는지 여부 (시작 위치를 알려 주었기 때문에), 무엇을해야하는지에 대한 명확한 제목을 제공했기 때문에 신속하게 이해하는 데 도움이됩니다. 그 시점에서 수행하고 결과가 어떻게 보일지.
이제 좋은 지침을 작성할 준비가되었습니다.
이제 작성 규칙을 알았으므로 항상 사용자의 관점을 염두에두고 지침을 작성하기 시작할 수 있습니다.
"작업 ABC를 수행하는 방법"지침의 제목을 지정하여이 제목 아래의 지침이 모두 ABC 작업 수행과 관련이 있는지 확인합니다 (다른 것은 없음). 이제 지침을 직접 작성할 준비가되었습니다.
가장 먼저해야 할 일은 사용자의 방향을 지정하는 것입니다. 사용자에게 현재 위치와보고 있어야하는 창의 이름과 같이 화면에 표시되어야하는 내용을 알려줍니다. 다음으로 현재 창에서 어떤 버튼을 누를 지 그리고 / 또는 어떤 필드에 어떤 텍스트를 입력해야하는지 알려주세요. 다음으로 다음 단계 / 위치로 이동하는 방법을 알려주고 해당 조치를 취할 때 화면에 표시되어야하는 내용을 설명합니다.
예를 들면 :
- 로부터 메인 창에서 활성화 할 모든 옵션을 선택합니다. 딸깍 하는 소리 확인. 그만큼 두 번째 창 선택한 옵션의 현재 상태가 표시됩니다.
- 에 두 번째 창, 선택한 모든 옵션이 올바른지 확인하십시오.
- 모든 옵션이 올 바르면 옵션 활성화. 그만큼 세 번째 창 나타납니다.
- 옵션이 모두 올바르지 않으면 뒤 로 돌아 가기 위해 메인 창 다른 옵션을 선택합니다.
최종 정리
작성이 끝나면 맞춤법 및 문법 검사기를 실행 한 다음 한 명 이상의 SME (주제 전문가) (제품을 알고있는 사람)가 문서를 검토하도록합니다. 변경하고 맞춤법 및 문법 검사기를 다시 실행하고 다른 사람이 문서를 교정 / 편집하도록합니다.
편집자가 변경 한 내용을 입력하면 일반적으로 완료된 것입니다 (회사에 공식 문서 릴리스 프로세스가있는 경우가 아니면 따라야합니다).
주제별 전문가와 편집자가 변경 한 내용 (정확한 문구 및 스타일에 대한 주제 내보내기)은 거의 의심의 여지없이 수락되어야합니다. 그들의 자신의 전문 분야를 알 수 있습니다. 만약 너라면 강하게 변경 사항에 동의하지 않는 경우에만 SME 또는 편집자의주의를 끌 수 있습니다. 그렇지 않으면 제안 된 변경을 수행하십시오.
사용성 테스트 지침
아주 좋은 초안이 있으면 여러 사람을 모집하여 지침을 테스트합니다. 처음부터 끝까지 검토하고 그들이 분실하거나 혼란 스럽거나 지침이 잘못된 부분을 기록하고 기록 할 수 있도록합니다.
이상적으로 사용성 테스터는 문서화 한 제품 / 웹 사이트의 실제 고객 / 사용자 여야합니다. 그러나, 당신이 작성한 내용에 익숙하지 않은 사무실 주변에서 몇 명을 모집하여 문서를 테스트하게하는 것은 아무것도없는 것보다 낫습니다. 이 경우 테스터는 주제별 전문가 사용자이므로 변경 사항은 제품 SME 및 편집자 (SME)의 변경 사항만큼 가치가 있습니다.
사용성 테스트 자체는이 기사에서 다루기에는 너무 광범위한 전체 분야입니다.
그러나 사용성 테스트를 변경 한 후에는 편집자 및 해당되는 경우 제품 / 서비스 SME를지나 변경 사항을 실행하십시오. 현재 또는 향후 릴리스에서 제품 / 서비스의 작은 변경은 큰 차이를 만들 것입니다. 사용자에게.
결론 및 일반화
소프트웨어 지침 작성에 대해 다음과 같은 결론과 일반화를 할 수 있습니다.
- 독자들은 당신의 작품을 읽을 때 실망합니다.
- 독자가 어디에 있는지, 무엇을해야하는지, 어디에서 끝날 것인지를 알려줌으로써 독자를 안심시켜야합니다.
- 전문가가 문서의 제품 정확성과 쓰기 정확성을 검토하도록해야합니다.
- 전문가가 변경 한 사항을 수락해야합니다. 상당히 동의하지 않는 경우 문제에 대해 해당 전문가에게 문의하십시오.
- 사용성 테스트는 문서가 사용자 / 독자의 요구 사항을 성공적으로 충족하는지 확인하는 가장 좋은 방법입니다. 제품 개선으로 이어질 수도 있습니다!
이 기사는 저자가 아는 한 정확하고 사실입니다. 콘텐츠는 정보 제공 또는 오락 목적으로 만 제공되며 비즈니스, 재정, 법률 또는 기술 문제에 대한 개인 상담이나 전문적인 조언을 대체하지 않습니다.
