ITエンジニア/デザイナ向けにオープンソースを毎日紹介

KirbyはFacebookのドキュメントシステムに似たドキュメントビューワーです。

最近ではWebサービスでAPIを提供することも珍しくなくなっています。そんな時にいかに分かりやすいコンテンツを提供するかは重要です。今回紹介するKirbyはFacebookのドキュメント風にテキストを表示してくれるドキュメントビューワーです。


トップページです。


左側のメニューから選んで右側のコンテンツが切り替わります。


階層メニューにも対応しています。


検索も使えます。

Kirbyはコンテンツフォルダの中にMarkdownフォーマットでファイルを追加していくだけで、Kirbyがドキュメントを自動生成してくれます。コードのシンタックスハイライト、検索機能もついています。社外はもちろん、社内向けにも便利そうなソフトウェアです。

KirbyはPHP製のソフトウェア(ソースコードは公開されていますがライセンスは明記されていません)です。


MOONGIFTはこう見る

FacebookのAPIドキュメントが読みやすいかと言われると疑問符がつくのですが、それでも多数のコンテンツとその場で試せるデモのお陰で役立っています。特にFacebookの場合はシステムの開発スピードが速いためにドキュメントと実際のAPIの内容が違ったりすることが多かったのですが、更新のしやすさというのが大きな問題になるでしょう。

その意味ではテキストファイル(Markdown)を使ったKirbyは更新がしやすそうです。Facebookのドキュメント形式に慣れた人であればKirbyのシステムにもすぐに馴染めるでしょう。また、GoogleやYahoo! Inc.などのドキュメントフォーマットに沿ったシステムがあっても面白いかも知れません。

Knowledge-Base

christianreber/kirbycms-knowledge-base

 

MOONGIFTの関連記事

コメント

  • DevRel
  • Com2