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

読みやすい開発者ドキュメントはDevRelにおいて大事な要件になります。コンテンツはもちろんですが、サイトとしても読みやすくできていなければなりません。文字サイズやインデックス、コードの可読性などが要素として考えられます。

今回はGoogleがメンテナンスしているDocsyを紹介します。DocsyはHugo向けのテンプレートになります。

Docsyの使い方

トップページです。

多言語対応をサポートしています。

コンテンツです。左側にインデックス、中央にコンテンツが表示されます。

フィードバックが常にフッターにあります。

ブログも含められます。

フッターにソーシャルリンクも。

DocsyはコンテンツがGitHub上にある前提となっており、ページから直接Issueを切れるようになっています。それによってユーザを巻き込んだコンテンツ作成が可能になります。オープンソースの仕組みを取り入れたコンテンツ作成が実現できます。

DocsyはHTML製のオープンソース・ソフトウェア(Apache Licnese 2.0)です。

Docsy

google/docsy: A set of Hugo doc templates for launching open source content.

 

MOONGIFTの関連記事

コメント

  • DevRel
  • Com2