종종 Ph.D가 이해해야하는 전문 용어, 두문자어 및 지침이 가득차 있기 때문에 소프트웨어 사용자 매뉴얼은 때로는 사용자가 아닌 개발자의 관점에서 작성됩니다. 결과적으로 가이드는 독자의 기술 수준에 대한 가정을 종종 부정확 할 수 있습니다. 좋은 사용자 매뉴얼을 작성하는 첫 번째 단계는 가능한 한 엔지니어로부터 멀리 떨어진 실제 작성 프로세스를 얻는 것입니다.
소프트웨어 개발자는 누구보다 소프트웨어가 작동하는 것을 알고 있지만 개발자가 가이드를 작성해야한다는 것을 의미하지는 않습니다. 반대로, 그것은 명백한 단점입니다. 소프트웨어의 내부 동작에 대한 깊은 이해보다 중요한 점은 최종 사용자가 누구인지, 교육 수준은 무엇인지, 최종 사용자가 소프트웨어를 사용하는 방법을 이해하는 것입니다. 대부분의 경우 최종 사용자는 프로그래밍의 세세한 부분과 소프트웨어의 백 엔드 작동을 알 필요가 없습니다. 단지 작업을 쉽게 수행하는 방법을 알아야합니다.
사용자 테스트
사용자 매뉴얼은 크게 설명하기보다는 주로 작업 지향적이어야합니다. 이 설명서는 사용자가 특정 작업을 수행하는 방법을 이해할 수 있도록 작성되었으므로 작성자는 이러한 작업을 이해할 필요가 있으므로 결과적으로 각 기능의 개별 단계를 거치는 것이 절대적으로 필요합니다. 작가가 디자인이나 개발 관점에서 프로그램이 어떻게 만들어 졌는지 반드시 알 필요는 없지만 모든 기능에 대한 강력한 실무 지식이 필수적입니다. 각 작업을 실행하는 동안 클릭, 드롭 다운 메뉴 및 기타 작업을 포함하여 모든 단계를 기록하십시오.
면접 과정
개발자는 매뉴얼을 작성하는 사람이 아니어야하지만 필자에게는 여전히 귀중한 자료가 될 것입니다. 작문을 시작하기 전에 작가, 개발자 및 엔지니어 간의 킥오프 미팅을 계획하고 잠재적 인 최종 사용자에게 처음부터 작가의 작품. 주제 전문가 및 엔지니어와의 인터뷰를 기록해야하며, 나중에 참조 할 수 있도록 성적 증명서를 제출해야합니다.
형상
사용자 설명서는 텍스트가 너무 길면 안됩니다. 오히려 그래픽과 스크린 클립을 자유롭게 사용하십시오. 동작 설명은 방향을 명확하게 보여주는 스크린 클립과 함께 텍스트 기반 방향이 훨씬 명확합니다. 이전 및 이후보기를 모두 포함하여 각 동작을 수행하기 전에 화면이 어떻게 보이는지, 동작이 수행 된 후에는 어떻게되는지를 보여줍니다. Microsoft Windows에 포함 된 Snipping Tool과 같은 간단한 화면 캡처 유틸리티는 이러한 이미지를 캡처하는 데 적합합니다. 각 이미지에 번호를 매기고 간단히 설명하는 캡션을 포함하십시오. 이미지에 묘사 된 개념을 처음으로 소개하는 단락 바로 아래에 가운데 놓으십시오.
서식 지정
기술 문서에서 명확하게 의사 소통하려면 가이드 전체에 걸쳐 표준을 세 심하게 고수해야합니다. 프레젠테이션, 언어 및 명명 표준 모두 혼란을 피할 수 있습니다. 템플리트는 사용 가능하며 균일성에 대한 좋은 출발점이 될 수 있습니다. 물론 각 상황에 맞게 적용 할 수 있습니다. 단일 열로 1 인치 여백을 사용하면 그래픽을 추가 할 필요가 가장 적합합니다. 2 열 설정이 너무 복잡해 보이고 이미지 배치를 혼란스럽게 만들 수 있습니다.
버전 관리 및 추적
다른 유형의 문서보다 소프트웨어 사용자 가이드는 완료되기 전에 여러 번 반복 될 가능성이 높으며 여러 이해 관계자가 검토 프로세스를 진행할 가능성이 큽니다. Microsoft Word에서 변경 내용 추적 기능을 사용하면 각 개인의 의견 및 변경 사항을 쉽게 추적 할 수 있습니다. 각각의 검토주기마다 여러 파일 이름을 가진 여러 버전을 만드는 것은 프로세스를 돕고 모든 이해 관계자가 최종 결과에 만족하는지 확인하는 데 도움이됩니다.
