HTMLでヘルプファイルを作成する

Question

大きなプロジェクト用のヘルプファイルを作成するという楽しい作業に直面しています。セクションの

再利用性：私は、私はに焦点を当てています3つの領域があります....

を伴う制約のためにCHMファイルを破棄し、現在HTMLベースのファイルに探しているが、私はまだフォーマットで未定です（多くのページは1つのテキストを参照することができます） ヘルプファイルで複数のセクションが複数回使用されるため、私はマスターセクションを作成し、各サブセクションのマスターセクションにリンクする必要があります。これにより、編集を行うときにキャプションを複数の場所に変更する必要がなくなります。

検索機能 私はファイル内のフリーテキストを検索できます。

印刷適性。 セクションを印刷したりドキュメントをフルにすることを選択できます。

この問題で皆さんからの任意の提案は...

私が最初の配布のための静的なページにWikiをエクスポートするプラグインを持つウィキアプローチに傾いたが、私はその解決策を見つけることができますか？ヘルプファイルを複雑にしていますか？

ありがとうございます！

Answer 1

再利用

私は2つのアプローチを参照してください。再利用するセクションの個々のページを作成し、適切な場所にリンクするだけです。これはHTMLでは簡単です。

代わりに、そのセクションの情報を含むスニペットまたはHTMLの断片を作成し、必要に応じてサーバー側インクルード（または同様のテクノロジ）を使用してインラインでインクルードすることができます。こうすることで、コンテンツはすべての個々のページに書き込まれたように見えますが、編集が必要なときは1つの場所にしか表示されません。

検索

サイトが公開されている場合は、Googleのインデックスにそれを聞かせて、ちょうどGoogleの検索ボックスを提供します。あなたはそれよりも良い結果を得る可能性は低いです。 CSSで

印刷適性

A「印刷スタイルシートは、」一緒に入れやすく、紙の上で使用するすべてのコンテンツを保存し、ウェブ上のサイトは魅力的にすべてのグラフィック要素を排除することができます。

文書全体を一度に印刷するには、すべての内容を1つのページにまとめて印刷するためのプログラミングが必要です。個人的には、人々に紙を浪費させないように、そのサービスを提供することさえも望みます。

もちろん、私たちはこれらのことを達成するためのあらゆる方法を提供することができますが、現時点で一般的なアドバイスを受けたように聞こえるので、それは私のものです。

Answer 2

特に、複数の人がプロジェクトに参加している（または参加する）人がいる場合は、ドキュメント化にウィキが最適だと思います。 wikiページまたは名前空間を簡単にリンクできます。ページの名前を変更すると、他のドキュメントのすべてのハイパーリンクが変更されます。私はそれがあなたが示唆しているものなら、可能な限りコンテンツの重複を避けるでしょう。

ページの書き出しをサポートするDokuWikiを使用します。 Wiki全体をプレーンテキスト、XHTML、またはXHTML本体にダンプすることができます（独自のテンプレートを入れたり、印刷するために単一のファイルに追加するなど）。

希望に役立ちます！