Feature #1214

ユーザーガイドのモード別利用方法を統合

Added by Kouhei Sutou over 6 years ago. Updated over 4 years ago.

Status:新規Start date:12/16/2011
Priority:NormalDue date:
Assignee:-% Done:

0%

Category:-
Target version:-

Description

h2. 問題

現在のユーザーガイドはストレージモード用のガイドとラッパーモード用のガイドが分かれている。これは、どちらかのモードだけを使いたいユーザーにとっては、そのページだけ上から順に読めばよいのでわかりやすいが、どちらかのモードを比較検討したいという場合には不便である。また、重複した記述が多いため、ドキュメントを記述する側にとっても、更新作業が不便である。

h2. 期待する状態

機能毎に別ファイルを作成し、includeディレクティブ ( "reStructuredText Primer":http://sphinx.pocoo.org/rest.html 参照)で適宜取り込むのはどうか。

これにより、ドキュメントの重複が少なくなるため、ドキュメント記述側の問題を解消できる。また、依然としてモード別のドキュメントも用意できるため、どちらかのモードだけを使いたいユーザーも不便にならない。

モードを比較検討したいユーザー向けに別途表形式で各モードでどの機能が利用できるかを示す。

h2. 解決方法

とりあえず、上記の方法でやってみて、うまくいかなそうなら別途考える。

History

#1 Updated by daijiro MORI over 4 years ago

  • Target version deleted (1.1x)

Also available in: Atom PDF