다른 사람에게 무언가를 수행하는 방법을 지시하는 문서 작성에 대한 책임이 있다면, 오늘날의 문서 작성 방법은 기존의 방법을 거의 없애 버립니다.
1. 큰 폭탄 헤더
이 문장 바로 위와 같은 PCMech의 헤더는 엄청납니다. 문서의 현재 위치를보고 읽고 이해하기 쉽기 때문입니다.
2. 적은 단어
잘못된 방법:
다음 문서는 Fanny Whacker 2000 사용 및 작동 방법을 설명합니다.
올바른 방법 :
Fanny Whacker 2000 사용 방법에 대한 지침
문서를 작성할 때이 문구를 항상 기억하십시오. 가능한 빨리 포인트를 얻으십시오.
쓸모없는 참조를 건너 뛰십시오
참조가 설명하려는 내용의 핵심 명령과 관련이없는 경우 :
Fanny Whacker 2000의 Turnip Twaddler에 대한 자세한 내용은 문서 FU, 하위 섹션 ID10T를 참조하십시오.
…하지 마십시오.
4. 날짜를 기입하십시오. 항상.
문서가 작성된 날짜는 모든 페이지의 바닥 글 영역에 있어야합니다. 전자 문서 인 경우 날짜가 두 번 표시됩니다. 처음에 한 번, 끝에서 한 번.
이것을 "최종 개정 (날짜 삽입)"으로 쓸 수 있습니다.
5. 경고는 항상 반품이없는 지점에 게시되어야합니다.
문서에 잘못 수행 된 경우 무언가를 손상 / 파기 / 폐기시킬 수있는 내용이있는 경우, 이 정보는 해당 지시 사항 바로 다음에 배치하고 평범한 시각 (같은 페이지에 있음)에 강조 표시해야합니다.
예:
5 단계. Fanny Whacker 2000 청소
FW2000의 패들은 비 마모성 부드러운 천으로 부드럽게 청소해야합니다.
경고 : 암모니아가없는 솔벤트 만 사용하여 FW2000이 폭발하여시의 적절하게 사망하지 않도록하십시오.
마지막으로, 좋은 문서는 상상할 수있는 모든 가능한 모든 것에 대해 슈퍼 설명 적이 아닙니다. 문서를 읽고 스스로에게 물어보십시오. 올바르게 지시합니까? 대답이 '예'인 경우 다음 질문은 신속하게 지시합니까? 그렇다면 문서가 좋습니다.
