Baykitのドキュメントを再構成および校正をします。
このWikiのマークアップ方法は、編集ボックスの下に記載されていますが、 あまり凝ったマークアップはしないほうが良いでしょう。特にマクロ系は あまり使わないようにしましょう。ページのトップには、tocマクロを 置いたほうが分かりやすいかも知れません。
ちなみに、データベースにはこの編集ボックスの内容がそのまま保存され、 ページ要求時にレンダリングされます。
ドキュメント再整備について、フォーマットやツールをどうしようかという議論 がありましたが、それはおいておいて、ドキュメントの再構成と校正をしません か？(というか、始めたいと思うのですが) (というか一人でもやらねばならんの ですが) で、構成方法ですが、今どういうドキュメントがあるかを洗い出して分類します。 他の人が日頃どのようなソフトウェアを使っているかは知りませんが、だいたい ソフトウェアに関係するドキュメントってこういう構成だよな、というのを基本 にしたいと思います。これは、新たにベイキットを触ってもらう人が、ドキュメ ントに簡単にアクセスできるために必要だと思います。 以下、個人的な意見です。 - Xiの仕様書は開発者文書という位置付けで、全面には出しません。 - リファレンスマニュアルが必要です。これは完全にリファレンス扱いです。 -- 現行のユースケースの部分は、逆引きリファレンスになるかな？ - チュートリアルが必要です。(もうありますね) - 簡単な導入とその次の段階の導入が必要です。 -- 簡単な導入は、1ページくらいの簡単なもの。 -- 次の段階の導入は、さらに詳しく知りたい人のためという位置付け。 - ライセンス文書 この程度でしょうか？ で、ツールですが、ドキュメントを書く前にツールの選定や作る方針などを考え ているとなかなか進まず、モチベーションも落ちるので、とにかくWikiで始めま しょう。 理由は、 - 派手な体裁は必要ないので、Wiki程度の簡単なマークアップで十分。 - ページの移動、パラグラフの移動などがやりやすい。 - ローカルではなく、一箇所のリモートでできる。 - ページの内容がテキストでアクセスできるWikiシステムであれば、最後に一括 変換してやれば良い。 -- 最終的には、CVSソースからビルドできるように、Antのstyleタスクで処理で きるといいと考えてますが。