SANOGRAPHIX BLOG

京都を拠点に活動する佐野章核 (sanographix) の個人ブログ。日記、webデザイン、読書、写真など。

GitBookでサポート用ドキュメント作る

f:id:sngrpx:20190206135345p:plain
サポートドキュメントってこういうやつです

自作のソフトウェア、というか自作のテーマ の問い合わせ対応をしていくなかで、よくある質問は1箇所にまとめて公開している。そのことについて。

テーマの使い方やFAQなどのサポートドキュメントを、当初GitHubにREADMEファイルとして置いていた。半年前にドキュメントをGitBookに移して、まあまあうまくいってる気がする。GitBookはドキュメントいい感じに作れるやつ。

ドキュメント置き場、GitHubのREADMEで大抵は事足りる。しかし、サイドバーに目次が必要なくらい長いドキュメントや、複数リポジトリに跨るようなプロジェクトでは、もう少し見やすくしたい欲が出てくる。また、自分の配布してるテーマは性質上、コーディング文化やGitHubに馴染みのないユーザーを主な対象にしており、そこにポンと置いておくのはなんとなくそっけない気がしている。気持ちの問題かもしれないけど。

GitBookはドキュメントに最適化された見た目で表示されるし、GUIエディタが使えてデプロイ作業もしなくていい。完全にニッチな事情だけど「デプロイしなくていい」のはTumblrテーマ的にもありがたい。なぜならGitHubリポジトリを紐づけているTumblrテーマは、 master に変更が走った瞬間に、(たとえドキュメントだろうが)テーマ審査チームへレビュー依頼が飛んでしまうからだ。以前ドキュメント用に何度もpushしまくって気まずい思いをした。

Special Offer

既刊まとめて25%オフ

所属サークルの同人誌5冊をセットにした、お得なバンドル。

BOOTHで購入する STORES.jpで購入する