[Seasar-kvasir 23] Re: ドキュメント作成手順について

[Tsunenaga Hanyuda]

羽生田です。

YOKOTA Takehiko wrote:

> Velocimacroを知らないとカスタマイズしづらいのですね。でもその辺は羽生田さ
> んにお任せすればよいのか（笑）。

文法などはそんなに沢山知る必要はないのですが、「あれもこれもやりたい」と
いう要求が出ると二、三歩足踏みする感じですかね。

> Windowsで環境を作りづらいのはつらいっすね。

そうなんですよ。探しているのですがちょっと見つからなくて...

> で、野望としては、ドキュメントもMaven2でビルドできないかなーと思っていま
> す。より正確には、ドキュメントのビルド（コンバート）も自動化したい、と。
> Kvasir/Soraプロジェクトでは極力手動のプロセスを減らしたいのです。
> 
> ＃そういう意味ではMaven2のsiteプラグインを使うのも一つの手？でもまだ日本語
> ＃まわりはいまいちっぽいし…。

siteプラグインは完全にプロジェクト管理用でドキュメントには不向きだと思っ
ていましたが、折角ですので他のツールとも併せて検討してみましょう。
Mavenを使うという意味ではMavenのAntプラグインでAnakiaTaskをキックするの
が手っ取り早いのかな...できるのだろうか。

> すいません、説明不足でしたが、Wikiシステムそのものを使うという意味ではなく
> て、Wikiの記法を使って記述してそれをコンバータでHTML化する、という意味合い
> です。
> 
> ＃ちなみにKvasir/Soraの3.0.0-EA1はWiki記法をサポートしていて、メディアタイプ
> ＃にtext/x-wikiを指定すればWiki記法で書いたページが表示可能です。なのでWiki
> ＃→HTMLコンバータはさらっと作れる状態です。

お…これはー。これも検討しましょう。

> それも良いですし、とりあえず私はplain text+α的な雰囲気でドキュメントを
> 書きますので、それと並行してドキュメント作成方式を検討する、というのでも
> いいかもしれません。まずQuick Start的なドキュメントは早めに出したいので、
> それはもう手動でHTML化してサイトに貼ってもいいかも。

了解しました。おっしゃっているQuick Start的なドキュメントは11月下旬に書
きあがるものだと勝手に考えていますが、いかがでしょう？比較・検討する深さ
を決めておきたいです。

> で、検討するなら選択肢の一つとしてMaven2のsiteプラグインも調べたいっす。^^)

というわけで以下のものを並べて検討することにします。

- Anakia (Velocity)
- docbook
- Wiki -> HTMLコンバータ (K/Sora Pluginとして)
- Maven2 siteゴール

APTは画像系が良くわからないということで外しました。
って、この続きは明日ですかね(^^;

ひとまず情報収集はじめます。
＃...って書いてる間にEA1リリースがっ
--
羽生田 恒永
hanizo ＠ pm.highway.ne.jp