Webアプリケーションのソフトウェア使用ドキュメントツール

Question

Webアプリケーションのソフトウェア使用方法のドキュメントを準備したいと考えています。これは主に、ほとんどのページにスクリーンショット（関連ドキュメントとともに）を含んでいます。また、対応するページにジャンプするためのトップメニューのリンクが必要です。

上記の要件を満たすのに役立つツールをご提案ください。

Answer 1

使用方法のドキュメントに必要なすべての機能を統合した素晴らしいツールがいくつかありますが、私が使っていることを教えてあげます。

私はwinkを使用して、使用中のアプリケーションのスクリーンショットを取得しています。私はそれを起動する傾向があり、私がアプリケーションを歩いたり、アプリケーションの一部だけを歩いたりすると、スクリーンショットの負荷がかかります。次に、冗長なスクリーンキャプチャを削除し、それらを並べ替えて、各フレームにマウスを置くために、プロジェクトをウインクで編集します。次に、私はデモンストレーションしている画面の部分の周りに通常はちょうど良いボックスである強調表示を追加します。ウィンクを使用すると、イメージを情報ボックスと矢印でオーバーレイすることができます。次に、プロジェクトをhtmlとしてエクスポートし、番号付きのエクスポートされたpngイメージをドキュメントのベースとして使用します。

私はそれらをOpenOffice Writer（またはあなたがタイプセットするために使用しているもの）にドラッグして、より多くの情報を補う傾向があります - つまり、ユーザーが何をしているのか、理由を説明します。

この文書を出力するにはacrobatを使用し、目次を提供することは適切に行われ、pdfにブックマークを挿入して関連するセクションにジャンプすることができます。

ウィンクから得られる主な利点は、状況が変化したときにショットを取り戻すことが非常に簡単で、フラッシュに出力してウェブ上に投稿するための小さな機能のすばらしいデモを提供できることです。

Answer 2

これはあなたのプロジェクトにとっては残酷かもしれませんが、私はdocbook（xml）のドキュメンテーションの準備は好きです。

文書の作成を簡略化するために、http://www.oxygenxml.com/に変更できますが、ほかのxml（またはテキスト）のエディターでも同じことができます。

文書が準備されたら、html（複数ページまたは単一ページ）とpdfバージョンを生成するのは簡単です。

Answer 3

Dr博士はかなりいいです。

http://www.drexplain.com/

それはあなたのページを分析し、コールアウトを必要とするなどのコントロール、ボタン、リストを作成します。

Answer 4

特定のドキュメントツールを念頭に置いてドキュメントを書く場合、HTMLへの出力は比較的簡単です。 LaTex、マークダウン（Pandocを念頭に置く）、reStructuredText（PandocまたはSphinxを念頭に置く）、AsciiDoc（DocBookツールを念頭に置く）、DocBook（Docbookツールを念頭に置く - Pandocを参照）。

これらの書式はすべて、書類を簡単に整理してHTMLに書き出すことができますが、適切なものと思われます（主に見出しを付けて、単純なラッパーを作成します）。 SphinxはWebベースのドキュメントを出力することもできます（Python.orgのドキュメントを参照）。

スクリーンショットについては、ご使用のプラットフォームでスタンドアロンアプリを使用することをおすすめします。プログラム内で注釈を付けることが理想的です。 MacのためのSkitch、WindowsのためのJing、シャッターshutter-project.orgまたはlinuxのJing。

最後に、スクリーンキャストを行うこともお勧めします。スクリーンキャストは、ウェブアプリの興味/パワーを誇示するのに特に役立ちます。

Answer 5

あなたのコードを書いている言語の王様はわかりませんが、の場合Javaの場合は、Mavenを使用できます。

は、Mavenのを使用すると、JavaDoc、あなたのAPI /ソフトウェアに関する多くの情報を持つサイトを作成し、トップメニューしたいが含まれているsiteのように、多くのプラグインを使用することができます。私はこれらが役立つことを願っlink

：

これが発生Mavenのサイトのスクリーンショットです！

乾杯