みなさんこんにちは。 おそらく、どの開発者も「開発プロセス中に最も嫌いなもの」という質問に答えるでしょう：「ドキュメントを書く」か、問題のリストの最初にそれについて言及します。 ドキュメントには本当に興味深いものは何もありませんが、それでも、 Habréの最初の投稿で書いたユーザーマニュアルは、プロ製品の重要なコンポーネントです。 不十分に書かれたドキュメントは、新しい顧客を引き付けるための障害になるだけでなく、製品と開発者のイメージにとって大きなマイナスになります。
同時に、優れたヘルプシステムを備えたプログラムがほぼ確実に購入されます。 誰もユーザーマニュアルを読んでいないという広く信じられているにもかかわらず、人生は反対を示しています。 ユーザーが以前に使用したことのない多機能プログラムを購入した場合、ユーザーの助けは参考書になり、プログラムの機能をすばやく習得し、プログラムの操作中に発生する質問への回答を見つけるために参照します。 したがって、明確で一貫性のある簡潔なユーザー参照は、製品とその利益の可能性の肯定的なイメージに常に大きなプラスになります。
私自身も時々ヘルプファイルを作成し、ヘルプシステムの作成には時間がかかり、骨の折れる退屈な作業、特にインターフェイスのドキュメント化を直接知っています。 しかし、数か月前に、このプロセスを大幅に高速化するツールを発見しました。 私たちはサマラに本拠を置くIndigo Byte SystemsのDr.Explainプログラムについて話している。 よく考え抜かれたインターフェイスと、半自動モードでソフトウェアインターフェイスを文書化できる機能が気に入っています。
Dr.Explain vs. ヘルプとマニュアル
したがって、Dr.Explainを使用すると、アプリケーションと共に配信するためのCHM形式のヘルプファイル、製品Webサイトに投稿するためのHTML形式のヘルプシステム、目次とリンクを含むPDFのユーザーマニュアルを作成できます。 ヘルプシステムは単一のソースからさまざまな形式で生成されるため、ソフトウェアの新しいバージョンがリリースされたときにドキュメントをすばやく更新できます。 この点で、Dr.Explainは私が長い間使ってきたHelp and Manualと違いはありません。
インターフェイスは2つの領域で構成されています。 1つ目は、プロジェクトコンテンツのツリー構造を持つナビゲーションバーです。 2番目はページエディターです。
ヘルプファイルの構造全体は、フォルダーとページのヘッダーを含むツリーで指定されます。 ページエディタは、テキストを記述および書式設定するための標準ツールで構成されており、ハイパーリンク、画像、表、変数を挿入するためのツールもあります。 これはすべてヘルプとマニュアルにもありますが、Dr.Explainのツールバーは、私の考えではもっと思慮深く配置されています。
比較する：
図1. Dr.Explainツールバー
図2.ヘルプと手動ツールバー
Dr.Explainの主な機能は、最も時間のかかるドキュメンテーションプロセスの自動化-ユーザーインターフェイスアノテーションの作成です。 はい、あなたは私を正しく理解しました。 自分でスクリーンショットを撮ったり、吹き出しや矢印を描いたり、プロジェクトにこのエコノミーをすべて手動で挿入したりする必要はありません-プログラムは、選択したインターフェースの任意の部分の写真を撮り、分析し、検索します（単独で！）すべての重要な要素（ボタン、コントロール、リスト） 、ヘルププロジェクトにスナップショットを挿入し、画像の矢印と説明的なコールアウトを自動的に配置します。 ユーザーは各リーダーの簡単な説明を入力するだけで済みます。
さらに、コールアウトにさらに詳細な説明を追加できます。 すべてのコールアウトについて、プログラムはコールアウト付きのスクリーンショットの下に配置される見栄えの良いプレートを自動的に生成し、これらすべての詳細な説明を含めることができます。
このようなインターフェースの半自動ドキュメント化により、ヘルプシステムの作成が大幅に高速化され、容易になります。 開発者はコールアウトに説明を追加するだけです。 ヘルプとマニュアルでは、これもすべて実行できますが、手動で実行する必要があります。 通常、私はSnagitでウィンドウの写真を撮り、写真の端を処理し、影を追加し、矢印を描きます。 そして、ウィンドウ要素を手動で文書化するために、プレートを作成し、ボタンとコントロールのスナップショットを切り取り、それらのエッジを処理してプロジェクトに貼り付け、各リーダーの説明を書きます。 これには多くの時間と労力が費やされます。
他の何か...
Dr.Explainには他の便利な機能がありますが、残念ながらヘルプとマニュアルにはありません。 たとえば、プロジェクトを表示する便利なモードがあります。対応するボタンを1回クリックするだけで、コンパイル後のヘルプがCHMまたはHTML形式でどのように見えるかをすばやく確認できます。 プレビューはエディターウィンドウで直接開きます。 私を信じて、これは非常に便利です。 ただし、マイナスのPDFプレビューはありません。 ヘルプとマニュアルで、ヘルプの外観を確認するには、プロジェクトを常にコンパイルする必要があります。
このプログラムには、状況依存ヘルプをアプリケーションに直接統合する機能（F1）、ナビゲーションツリー、一連のデザインテンプレート、CSSサポート、イラストを置き換えることでプログラムの新しいバージョンがリリースされたときにドキュメントをすばやく更新する機能もありますが、要約、注釈、説明は保存されます; プログラミング（PHP、ASP）またはサーバー側データベースなしのオンラインヘルプの検索およびインデックス機能。
まとめ
ここで、おそらく、ここでお話ししたかったすべての主要なポイントがあります。 2か月前にプログラムを初めて見たとき、私はDr.Explainの簡単な概要を書きたかったのですが、このベンチャーを無期限に延期しました。 そして最近、 ヘルプとマニュアルでユーザーヘルプを再度準備していましたが、 Dr.Explainでインターフェイスを文書化する方がより便利であると改めて確信しました 。