많은 조직에서 사내 도구를 생산하거나 상업적으로 사용 가능한 도구를 자체적으로 사용할 수 있도록 수정합니다. 이러한 도구는 조직의 다른 사람들이 사용할 수 있도록 문서화되어야합니다..
이 문서가 작성되지 않았거나 잘못 작성되면 다음과 같이 두 번 비용이 부과됩니다.
* 첫 번째 비용 (가난한 사용자 문서에 기인 한 비용)은 사용자의 질문 (기술 지원)에 응답하는 비용입니다..
* 두 번째 비용은 불쌍한 사용자 문서를 이해하려는 직원의 시간 낭비로 인해 발생합니다..
작은 공간에 사는 사람들 - 홍콩 : 세계에서 가장 바쁜 도시 | BBC 2
심리적 비용은 외부 및 사내 사용자 모두에게 영향을줍니다..
최초 비용 : 기술 지원
이는 사용자 문서가 열악하거나 (또는 아예) 생성 될 때마다 발생하는 비용입니다. 기술 지원이 필요할 때 모든 사용자에게 발생합니다. 외부 사용자의 경우 기술 지원 직원, 수신자 부담 전화 회선 등이 비용이됩니다..
내부 사용자의 경우 비용은 동료 직원의 질문에 답변하기 위해 개발자 또는 수정 자에게 보낸 시간입니다. 이것은 값 비싼 기술 지원 비용입니다 ...이 사람들은 일반적으로 기술 지원 직원보다 더 많이 지불됩니다. 따라서이 첫 번째 비용은 대중에게 공개 된 겉만 번지르르 한 문서보다 가난한 사내 문서의 경우 훨씬 더 큽니다..
두 번째 비용 : 사용자의 시간과 자원
회사 외부의 사용자의 경우 두 번째 비용은 사용자 자신이나 고용주가 부담합니다. 이러한 혼란스러운 사용자는 회사의 시간을 보냈습니다. 제품을 작동 시키려고 노력한 시간과 기술 지원을 처리하는 데 걸린 시간.
사내 사용자의 경우이 비용은 회사에서 부담합니다. 당신의 회사 직원이 당신의 시간에 - 당신의 회사 자원을 낭비하는 제품이나 문서를 사용하려고합니다. 당신의 결점이있는 사내 문서가 당신에게 두 번 비용을 부과하는 곳입니다.
심리적 비용이 모든 독자에게 영향을 미침
이러한 시간과 금전적 인 비용 외에도 가난한 사용자 문서로 인한 심리적 비용이 있습니다..
회사 외부의 좌절한 사용자의 경우 문서가 불충분하면 회사와 제품에 대한 부정적인 인식이 생깁니다. 이로 인해 사업이 중단 될 수 있습니다..
회사 내부의 사용자의 경우 이러한 가능한 진술에서 알 수 있듯이 심리적 비용은 직원 사기를 감소시킵니다.
* 우리 회사에서이 정크를 생산했습니다.?
*이 사람들은 내가 생각하기에 날카로운 것이 아니다..
* 다른 직원이이 혼란스러운 물건을 생산할 수 있다면 같은 수준에서 일할 수 있습니다..
따라서 귀하의 회사 외부에있는 아픈 사람들은 당신에게 미래의 판매 비용을 지불 할 수 있습니다. 회사 내부의 나쁜 의도로 인해 직원 사기가 감소 할 수 있습니다..
해결책 : 비공식적 인 리뷰
사내 도구 용 사용자 문서를 작성하면 해당 문서를 비공식적으로 검토해야합니다.
자체 검토
저자는 자신의 첫 번째 리뷰를 수행 할 수 있습니다..
워드 프로세서의 맞춤법 검사기를 사용하여 일반적인 오류를 수정하십시오. 워드 프로세서의 문법 검사기를 사용할 수 있지만 대부분 정확하지 않습니다..
이 검토를하기 전에 문서가 하루나 이틀 동안 앉아있게하십시오. 이것은 당신이 당신의 불분명 한 글에서 의미했던 것을 잊어 버리는 것을 도울 것입니다. 당신이 리뷰를 할 때 :내가 여기서 무엇을 의미 했습니까?: 문서에서 수정이 필요한 부분을 발견하게 될 것입니다..
리뷰를 할 때, 당신이 문서의 도구와 독자의 사용자라고 상상해보십시오. 도구 사용자가 원하는 작업을 상상해보십시오. 이 문서를 통해 독자는 필요한 것을 찾을 수 있습니까? 글쓰기가 정확하고 (도구에 대해 정확하게 설명하고) 명확하고 완전합니까? 문서를 개선 할 수있는 변경.
외부 검토
그런 다음 가능한 경우 외부 검토 자 (회사 내부)를 사용하십시오. 이를 위해 작가는 다음을 수행해야합니다.
1. 도구의 잠재적 사용자를 찾습니다. 이것은 도구에 익숙하지 않은 사람이어야하며 타당한 도구의 대상 고객과 비슷해야합니다.
2.이 비평가가 문서를 사용하여 도구 사용에 대한 지침을 작성하게하십시오. 문서에 대한 의견을 묻습니다. 검토자가 요청한 제안 된 변경, 추가, 삭제, 설명에 유의하십시오. 몇 가지 질문 사항은 다음과 같습니다.
*이 문서는 귀하가 알아야 할 것을 알려줍니다?
* 문서에서 필요한 것을 쉽게 찾을 수 있습니까??
* 문서가 귀하의 질문에 답변합니까? 그렇지 않은 경우 어떤 질문에 답이 나오지 않습니다.?
* 문서를 쉽게 따라 할 수 있습니까? 그렇지 않은 경우, 문제 영역은 어디에 있습니까??
3. 작가는 필요에 따라 변경해야합니다..
이 :준 정식:검토를 수행 할 수없는 경우 자신 이외의 사람이 문서를 읽도록하고 개선을위한 제안을하십시오.
주의
검토 절차가 사내 사용자를 위해 사용자 문서를 작성하는 사람들에게 금지가되지 않도록하십시오. 결과를 양질의 결과로 만드는 협동 (협박이 아닌) 메커니즘을 강조하십시오. 완벽한 사용자 문서를 만들지 마라..