최종 사용자 문서 예제에 대한 좋은 참고 자료 및 조언 [닫기]

사내 소프트웨어는 많은 사용자에게 사용되었으며 교육 부서는 최종 사용자 문서 형식에 대한 팁을 요청했습니다.

교육 부서에서 영감을 얻거나 조언이 필요한 사이트에 사용할 소프트웨어 최종 사용자 설명서의 좋은 예를 어디에서 찾을 수 있습니까?

이것은 이 질문 과 비슷 하지만 기술이 아닌 사용자가 사용할 최종 사용자 설명서를 찾고 있습니다.

사내 사용자와 소프트웨어에 대한 인터뷰를 시작하고 그들이 알고 싶은 정보의 종류를 알아볼 수 있습니다.

제가 소프트웨어에 관해 작성한 많은 문서들은 한 명 또는 여러 명의 관객을 염두에두고있었습니다. 훈련 부서는 아마도 TOC와 같은 일련의 주제로부터 이익을 얻을 것입니다. 따라서 관련된 주제와 교육 목표와 관련이없는 주제를 논의 할 수 있습니다.

일부 주제는 다음을 포함 할 수 있습니다.

1. 대상 고객
2. 기술 요구 사항
3. 설치 방법 (해당되는 경우)
4. 프로세스 (즉, 소프트웨어는 어떤 비즈니스 기능을 수행합니까?)
5. 기능 세트 (소프트웨어의 기능은 무엇입니까?)
   • 사용자 추가 또는 문서 추가 와 같은 작업 기반 접근 방식이있을 수 있습니다.
   • 사용자, 역할과 같은 객체 기반 접근 방식을 가질 수 있습니다.
   • 메뉴 기반 접근 방식 (예 : 파일 메뉴,보기 메뉴)이있을 수 있습니다.
6. 마지막으로, 다가오는 기능 및 FAQ 섹션은 점점 더 많은 제품에 대한 지식 저장소 역할을 할 수 있습니다.

최종 사용자의 소프트웨어 개발 지식, 기능에 대한 지식 및 최종 사용자와의 인터뷰를 바탕으로 최종 사용자가 소프트웨어를 어떻게 사용하는지 예상하십시오.

가장 중요한 것은 읽고 싶은 문서를 작성하고 재미있는 예제 이름을 사용하여 설명하고 많은 주석이 달린 스크린 샷을 사용하십시오.

도움이 되었기를 바랍니다

몇 가지 "최종 사용자 안내서"를 읽었으며 그 중 하나를 썼으며 그 효과를 향상시키는 요소가 많이 있다고 생각합니다.

• 명령을 내리거나 조치를 취하는 방법을 이미지와 함께 보여줍니다 (예 : 스크린 샷).
• 무언가를해야 할 필요성과 그것을 달성하는 방법에 초점을 맞추십시오. 예를 들어 해당 작업이 얼마나 최적화되어 있는지에 대한 기술적 인 설명은 피하십시오.
• 모듈을 설명하는 순서도를 입력하면 소프트웨어가 분할되어 유용하지 않다는 의견을 받았습니다.
• 문제 해결 섹션이 유용 할 수 있도록 사용자에게 발생할 수있는 문제를 예측해보십시오 . 또한 프로그램 개발에 관여하지 않은 사용자, 다른 프로젝트에 참여한 동료까지도 프로그램을 테스트해야합니다.
• 지루한 설명을 피하십시오. 추가 정보는 부록이나 그와 비슷한 것에 넣을 수 있습니다.

이것이 당신에게 도움이되기를 바랍니다.

당신은 그것이 훈련에 사용될 것이라고 언급했습니다.

당신이 교육 문서보다는 참조 문서를 찾고 있다면, 내가 좋아하는 그런 사이트는 의욕에 Spolsky 조엘의 튜토리얼은 여기 .

1. 간단하고 깨끗한 프리젠 테이션. 보기 좋네요.
2. 권위 있지만 개인적인 목소리. 좋은 대학 강의에있는 것 같습니다.
3. 많은 양의 실제 스크린 샷이 아닌 간단한 그림. 왜 이것이 작동하는지 냅킨 뒷면을 읽으십시오 .

교육 문서가 Joel의 Mercurial 튜토리얼보다 1/2 정도 시원했다면 읽어 보았습니다. 그러나 위 3 점을 복사 할 수 있더라도 a) 글에 대한 열정과 b) 지식을 끌어낼 수있는 놀라운 지식을 가진 사람이 필요합니다. 그것이 효과가 있기를 바랍니다.

이것이 귀하의 요구에 맞는지 모르겠지만 온라인 문서 작성을 용이하게하는 기술 문서 스핑크스 에 사용되는 시스템이 있습니다. 관심있는 분야에 이와 같은 것을 사용할 수 있습니까?

또한 방금 ReadTheDocs 를 가로 질러 실행 했지만 호스팅 솔루션입니다.

기술 커뮤니케이션 협회 (STC)를 확인하십시오 . 많은 수상자들이 일반적으로 이용할 수있는 작품을 썼습니다. 또한 샘플을 이용할 수 있습니다. 회원이되면 더 많은 정보를 이용할 수 있습니다.