開發人員為了將元件整合成系統,都需要花許多時間在讀書、讀文件上。開發 Microsoft 或 Apple 桌面軟體就不用說了,有各式 SDK 文件需要讀。開發 Web Application 也是,有很多網頁規格、標準需要去理解。

而利用開放源碼元件,如我,除了有程式碼可以讀以外,更需要花相當多的時間去閱讀大量的文件。 因為,「看別人的 code 最困難的地方,大概莫過於了解他人的意圖 -lukhnos」。

Perl 方面的文件一開始自然是透過 perldoc 這個程式。但近年來我想也有許多人養成了直接在 search.cpan.org 網站上看文件的習慣,因為有連結及搜尋的關係,十分方便。另一方面自然就是,透過 cpan 安裝的模組,在此網站上就自然會有文件可以看。

Ruby 語言的 rubygems 所裝的文件就沒有這麼集中處理,慣例上每個 gem 的作者可能會自已安排一個網站去放 rdoc 產生出來的文件。像是 http://gpx.rubyforge.org/rdoc/ 這種感覺。Ruby 語言的話,萬物皆物件,所以文件編排上面就可以跟著類別走,像 javadoc。也算是十分便利。不過,本機裝好的 rubygems 也可以利用執行 'gem server',再透過瀏覽器去讀本機 rubygems 的 rdoc。

最近發現 Perldoc::Server 這個模組,實做了一樣的功能。不過與其說是模組,也許說是應用程式比較恰當。這是個用 Catalyst 寫成的應用程式。使用的話,需要自行將 Perldoc-Server 的 tarball 下載回來,解開之後執行:

> perl script/perldoc_server_server.pl
You can connect to your server at http://localhost:3000

那麼再連去 localhost:3000 讀文件,畫面大致上像這樣:

perldoc-server

URL 安排得頂不錯的,畫面也弄得夠好看 (其實就是 http://perldoc.perl.org/ 的風格),不過感覺速度上還可以需要再加強一些。應該很值得期待。