VineSeed ML アーカイブ



[VineSeed:026028] Re: 7.x に向けたドキュメント整備要領の変更について

  • From: Munehiro Yamamoto <munepi@xxxxxxxxxxxxxxxx>
  • Subject: [VineSeed:026028] Re: 7.x に向けたドキュメント整備要領の変更について
  • Date: Sat, 19 Jan 2013 01:21:11 +0900
山本@千葉のおうちです。

2013年1月12日 6:00 Yasumichi Akahoshi <yasumichi@xxxxxxxxxxxxx>:
>  赤星です。
>  これまで DocBook XML で記述し
> Subversion によるバージョン管理を行なってきましたが、
> DocBook XML はタグが豊富すぎ覚えるのが困難、

Vine のドキュメント内で実際に使っていた DocBook XML のタグ数は、
少ない印象を持っています。
また、わたし自身が DocBook で記述するときは、
そもそもタグを覚えていません(笑
適当なひな形とかこれまでタグ付けされた XML を参考にすれば、
なんとかなるものです。
どうしても詳しく知りたいときに、DocBook のドキュメントを見ていた程度でした。



>  そこで Vine Linux 7.0 に向けたドキュメントの整備を試験的に trac wiki で行いたいと
> 考えています。現在、
>
> http://trac.vinelinux.org/wiki/docs
>
> 以下に準備を進めています。

良いんじゃないでしょうか。

> アカウントが必要ですが、trac による整備の利点としては、
>
> ・ドキュメントを読んでいて修正したいと思えばすぐに修正を始められる。
>  (DocBook の場合、HTML で確認中に修正したいところが出てきた場合、該当のソースを
> 探す手間があるというのと比較して)
> ・編集中にプレビューを確認しやすい。
> ・DocBook と比較して覚える書式が少ない。
>
> などがあると思います。

Vine のドキュメント作成参入への敷居が下がるのと、
変更点がすぐに確認できるのは良いですね。


> 不利点としては、
>
> ・ローカルパッケージとして配布するためには何らかの変換処置が必要

trac wiki 記法の適当な parser はあるのでしょうか?
適当な軽量言語で既存のモジュールがあれば、変換処置も比較的簡単そうですね。
# 「trac の python コードを読め、以上!」では無くてですね… (^^;;
また、AsciiDoc の記法は Wiki のそれに近いので、
asciidoc 記法に落とす手もあるかもしれません。

> ・Subversion のように一括でブランチを作成することができない(?)
>
> が考えられます。

保留…。
テキストエディタから trac Wiki をいじれると、便利!?


それからそもそも…
Vine のドキュメント作成する範囲において、trac wiki の記法内で収まるのでしょうか?
赤星さんが trac wiki で Vine のドキュメント作成を試みようとお考えになられているので、
きっと trac wiki の記法の使用内で、Vine のドキュメントを一通り記述できるのでしょう。

--
山本 宗宏 Munehiro "munepi" Yamamoto
    Project Vine Public Relations <munepi@xxxxxxxxxxxxx>
GPG Key ID: 0xC24B55FD
GPG Key Fingerprint: 61EC 85A8 5F34 5E35 91E8  8AD0 1D28 D5DE C24B 55FD
_______________________________________________
VineSeed mailing list
VineSeed@xxxxxxxxxxxxx
http://lists.vinelinux.org/mailman/listinfo/vineseed