http://www.typemiss.net/blog/kounoike/20060120-54

[seiunsky]

CPAN でのドキュメントの書き方。

[webmarksjp]

Perl

[akiyan]

そう、モジュールのドキュメントでまず提供すべきは使用例。CPAN以外の話で、誰かが使う可能性のある自作モジュールの先頭には使用例を書いておくと吉です。

[mzp]

マニュアルの書き順

[pasinori]

参考

[Wacky]

SYNOPSISでモジュールの使い方をまず大雑把に示すことになっている。

[shioki]

"「ドキュメントの構造が統一されている」と書いたが，それだけでは無いんだなということに気づいたので追記。実はこの順番は読みやすいドキュメントになるようになっている。良く考えたらUNIXのmanと同じ構成なのです"

[Qma]

CPANドキュメント

[uemu]

ふむふむ

[nilab]

SYNOPSIS重要。 : CPANモジュールのドキュメントの良いところ～読みやすいドキュメント | Typemiss.net

[sato018]

perl cpan

[shidho]

なるほどねえ。

[fukken]

ドキュメントはユーザの興味と理解順序を考慮して書くべし

[hiro_y]

ドキュメントの重要性。CPANのドキュメントは構成がわかりやすい。

[lockcole]

フォーマットが統一されている点もさることながら，構成の順序がモジュールを調べるユーザにとって非常に合理的で読んでもらいやすい形になっているということ。確かに，まずサンプルを見せてくれるのは嬉しいよね。

[Cortel]

SYNOPSIS の位置がよい