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

開発者向けにサービスを提供している場合、ドキュメントは最重要な施策の一つです。ドキュメントがみすぼらしいと、誰も使いたいと思わないでしょう。過不足なく書かれたドキュメントを作るのは大変なことです。

今回紹介するDocuowlはそんなドキュメントを生成するソフトウェアになります。

Docuowlの使い方

左側にリソース、中央にコンテンツ、そして右側に実行例と結果が表示されます。

入力値に関する説明も出ます。

検索でドキュメントをジャンプできます。

DocuowlはStripeのドキュメントを参考にしています。ドキュメントはMarkdownから生成するタイプで、メンテナンスはしやすいでしょう。Markdownはフォルダとファイルの構成で管理するので、バージョン管理していると使いやすそうです。

DocuowlはGo製のオープンソース・ソフトウェア(MIT License)です。

Docuowl

docuowl/docuowl: ? A documentation generator

 

MOONGIFTの関連記事

  • DevRel
  • Com2