웹 앱의 대화식 매뉴얼의 예 [폐쇄

Question

내 웹 앱에 대한 도움말 (예 : 일부 버튼에 대한 설명을 표시)을 작성해야합니다. 이 작업을 수행하는 좋은 예가 있습니까?

Answer 1

Build Engine Hudson의 도움이 매우 우아하고 개별적이라는 것을 알았습니다.

도움말 아이콘이 있고, 클릭하고, 도움말 텍스트가 페이지에서 인라인으로 확장되고 다시 클릭하면 사라집니다.

시작해보십시오 https://hudson.dev.java.net/hudson.jnlp 그리고 tohttp : // localhost : 8080/구성을 구성하고 오른쪽에있는 많은 (?) 버튼을 클릭하십시오.

Answer 2

Java Doc Java 코드 파일 내부에 통합 된 모든 주석을 추출하는 데 사용할 수 있습니다.

Answer 3

Javahelp를 살펴보십시오. 이전 버전의 Windows에서 찾은 도움말 시스템을 에뮬레이션합니다.

Answer 4

위키에 문서를 작성하는 것은 매우 현대적입니다. 편집하기 쉽고 구조에 좋습니다.
그러나 나는 그것을 싫어한다. 나는 그것을 정말로 싫어한다. 잘 구조화되고 읽기 쉬운 적이 없습니다. 위키에 넣어야하는 많은 노력이 있습니다.

따라서 간단한 CMS를 사용하는 것이 좋습니다. 과잉이없고 링크가있는 텍스트 편집 만하십시오. WebApp에 통합 할 수있는 옵션이 있으며 PDF를 추출 할 수 있습니다.
이것은 인쇄 등 오프라인 도움말을 제공하는 데 깔끔합니다.

Answer 5

나는 좋은 오래된 HTML/CSS를 사용합니다. 이것은 사용자가 이미 브라우저에서 알고있는 동작을 유지할 것이며 이미 응용 프로그램의 스타일 시트가 있어야하므로 추가 노력이 거의없이 도움말 페이지를 통해 L & F를 유지해야합니다.

Google지도의 도움말을 살펴보십시오 (http://maps.google.co.uk/support/) - 레이아웃 아이디어 등

Google 도움말 페이지를 살펴 보았을 때 눈에 띄는 것은 검색 (놀라움이 없음)이었습니다.이 사이트는 외부에 직면 한 경우 '사이트와 함께이를 구현하겠습니다.귀하의 사이트> '키워드 및 Google 검색을 사용합니다. 귀하의 사이트가 내부 인 경우 자신의 검색을 굴려야하지만 너무 어렵지 않아야하며 아마도 재미있는 하위 프로젝트 일 것입니다.

Answer 6

PHP를 사용하는 경우 살펴보십시오 phpdocumentor.

PHPDocumentor 도구는 PHP로 작성된 Javadoc과 유사한 독립형 자동 다용도입니다.

Answer 7

각 버튼이 무엇을하는지 설명하는 사용자 설명서를 생성하려는 경우와 같은 것을 사용했습니다. 디버그 모드 윙크 또는 Adobe는 화면 상호 작용을 기록한 다음 플래시 영화 또는 PDF로 변환하는 데 유용합니다.

Answer 8

특히 레일의 경우 :http://github.com/darthapo/comatose/tree/master imbedded help 시스템에 사용할 수있는 훌륭한 작은 CMS 도구입니다.

그렇지 않으면, http://tenderapp.com/ 호스팅 된 솔루션으로 잘 작동합니다.