異なるプラットフォームで同じ製品の 3 つのユーザー マニュアルを作成する必要があり、変更が非常に少ないため、ソフトウェアのユーザー マニュアルを作成するために Dokuwiki を使用しようとしています。Dokuwiki で、さまざまな製品に使用できる共通のユーザーマニュアルを作成する方法はありますか?
2 に答える
DokuWiki の詳細については、サイト エクスポートプラグインをお勧めします (主な理由は、私が作成し、ドキュメントにも使用しているためです)。
Wiki の通常のページと同じように、ブックの章を作成できます。それらを別の本にまとめることになると、別の名前空間に「toc」というページを作成します。次の構文があります (詳細については、github ページを参照してください)。
* [[namespace:chapter1]] * [[名前空間:chapter1.1]] * [[名前空間:chapter1.2]] * [[namespace:chapter2]] * [[名前空間:chapter2.1]] * [[namespace:chapter2.2]]
これで、roc オプションを有効にしてこの名前空間をエクスポートし、1 つのドキュメントにマージできます。また、カスタムの本のようなスタイルで PDF エクスポートを使用することもできます (これは私たちが主に行っていることです)。
この回答は、DokuWiki だけでなく、あらゆる Wiki エンジンに適用されます。
基本的に、ドキュメントの共通部分を、製品固有のページに含めることができる個別のページに分割する必要があります。DokuWiki の場合、これにはインクルード プラグイン ( www.dokuwiki.org/plugin:include ) が必要ですが、トランスクルージョンはウィキのコア機能であることがよくあります。最も一般的な製品のドキュメントを書き始めてから、そのドキュメントのどの部分を引き出して一般的なドキュメントに使用できるかを確認することをお勧めします。