きり丸の技術日記

技術・エンジニアのイベント・資格等はこちらにまとめる予定です

資料管理にGoogle Siteとgitbookを使用しています

Gitbookの環境構築をする記事を書こうと思ったのですが、会社がMacで自宅がWindowsだからか、かなり環境構築に時間がかかってしまい、諦めています。

なので、弊社ではこういう資料管理してますよ、という程度の共有記事です。


現職では、資料管理にGoogle Siteとgitbookを使用しています。

使い分けとしては、以下の通りです。

Google Site

プロジェクト以外の資料をまとめてます。
部の目標資料とか、部屋の使い方、本の借り方等々…。

システムを運用している場合は、システムに特化した情報を集めていたりします。
現在の部署ではシステムを運用していないので、部署で実施した過去のプロジェクト概要とかそういうのしか載せてません。

なお、入社した時には既に使用していたので、選定理由は分かりません。
G Suiteで契約しているので、そのまま使えるから…だと思います。

markdownが使えないのが正直イケてない部分なので、機会があればGrowi等の人気のWikiに切り替えたいと思っています。
server運用費も地味にかかっちゃいますから、いつやろうかな…。

URL

https://sites.google.com/new

gitbook

開発者が使用するプロジェクトの資料を載せてます。
設計書を元に、開発者用に作成しなおした設計書とか。

大元の設計書を使用してもいいんですが、Excelで記載されていることが多くて図をいじることが増えてしまい…。
必要なら大元も修正しますが、その流れを壊さない程度に詳細化するときはこちらを使用することが多いです。

pluginでplantUMLでの記載もできるので、サクっとクラス図を作成するときは便利。
拡張すればPDF等にもできるので、そのまま設計書にすることもできる。

拡張しなくても、htmlにはなるのでCIサーバで常に最新の設計書を公開しておくこともできる。

dockerもあるので、ある程度カスタマイズするのであれば、dockerで構築したほうが楽だと思う。

GitURL

https://github.com/GitbookIO/gitbook

使い方

正直、家の環境で構築できてないので、他の記事を見た方がいいと思います。

CLIのインストール

npm install -g gitbook-cli

初期化

gitbook init

サーバーを立てる

gitbook serve

プラグインを導入したときにinstallする

gitbook install

きり丸練習用Gitページ

https://github.com/hirotoKirimaru/gitbook/network/alerts


2020/08/13追記
gitbook cliのアップデートがされなくなったので、後継のhonkitというrepositoryでforkされています。
おそらく、今後はこちらのリポジトリを使用したほうがいいと思うので、ぜひ使ってみてください。

私はまだ使えてないです。

github.com