2008-10-20 1 views
1

소프트웨어 응용 프로그램에 대한 사용자 가이드를 작성하는 데 도움이되는 리소스 링크를 찾고 있습니다. 나는 나의 가이드를 구조화하고, 적절한 글쓰기 스타일을 부여하며, 전반적으로 훌륭한 외관과 느낌을 갖도록 도움을 줄 수있는 무언가를 찾는다.소프트웨어 응용 프로그램 사용자 가이드에 적합한 템플릿은 어디에서 찾을 수 있습니까?

+0

일부 사용자층에 대한 도움이 될 수도 있습니다. 누구든지 될 수 있습니까? 아니면 개발자가 될 가능성이 있습니까?/기술적으로 마음이 들었습니까? –

+0

작성중인 소프트웨어의 종류에 따라 도움이 될 것입니다. 예를 들어 소프트웨어가 Microsoft Word와 비슷하다면 사용자 안내서 템플리트를 쉽게 제안 할 수 있습니다. –

답변

2

이 링크에는 몇 가지 장점이 있습니다. 각 포인트는 명확한 연설과 인라인 정당화와 함께 제시됩니다.

절차를 작성

에서, 능동태를 사용 (예를 들어, 이것을 클릭)하고 주소 사용자가 직접 (쓰기 "를" 보다는 "사용자").

작업을 설명 할 때, 동사의 "명령"양식을 사용 :

"이 메뉴 [ENTER]를 누릅니다에서 옵션을 선택합니다."

는 상기 기사에 다루는 주제의 전체 목록입니다

  • 서문
  • 내용
  • 가이드의
  • 바디
  • 절차
  • 작성 절차 텍스트에게 사용
  • 수 1 단계
  • 청크
  • 만약을-그런 물질
  • 돌아 가기
  • 참고 자료 접근
  • 용어집
  • I ndex
  • 구조에 대한 사용자
  • 재료에 제시
  • 특별 요구 사항
  • 0

    주소 표준

  • 형식
  • 구조 스타일
  • 기술 언어
  • 구축과 느낌 + 볼 DocBook과 같은 프레임 워크를 사용해보십시오.

    DocBook은 문서 정렬 방법을 생각하게하는 XML 마크 업 스키마를 사용합니다. HTML 및 PDF와 같은 일반적인 형식으로 변환하는 XSL 변환이있어 원하는 모양으로 보이도록 구성 옵션 전체를로드 할 수 있습니다. 오픈 소스 (무료)입니다. 단점은 물론 스키마가 상당히 크고 좋은 XML 편집기가 없으면 편집이 힘들 수 있습니다.

    예 : http://wiki.docbook.org/topic/WhoUsesDocBook