SIOS Coatiのオンラインマニュアルの作成方法(前編)

SIOS Coatiのチームにいる高正(たかしょう)です。
梅雨が開けて夏真っ盛りの今みなさまいかがお過ごしでしょうか。

SIOS CoatiのGA日は2017年2月23日なので、気がつけばリリースから5ヶ月経過したわけですね。早いものです。
その間私は寝起きの腰痛に悩まされ布団からそこそこお値段のするマットレスを買ったり、元気が出ないのでマルチビタミンのサプリに手を出したり、素敵なふんどしを探したり、つまりはなんとか足掻きながら生きていたわけです。

SIOS Coatiをたくさん売れるようにしたい人たちは日々色々な施策を考えています。
いつのまにか、コーティーくんというキャラが気がつけば出来上がり、着ぐるみまで作ってしまうのですもの。
嗚呼なんて素敵なことでしょう。
5月のAWS Summit 2017では企業ブースの対応に駆り出された時に、初めてコーティーくんを見た時の衝撃たるや。

 

 

 

 

 

 

 

 

 

 

 

 

 

 

ブース対応の時に、お客さんの反応が好意的でびっくりしたものです。コーティーくんの女子受けが良いことにとても驚いています。

 

 

 

世の中、何がウケるかわからないものです。コーティーくんの認知度に負けないように私もそれなりに頑張りたいと思います。

ここからはちょっと真面目にTechの話を書きます。

SIOS Coatiは初リリース時はマニュアルをgoogleドキュメントで書いてPDF化してお客様に提供していました。
でもこの方式だと色々と手間があって、開発者が積極的にドキュメントをメンテナンスをしていくモチベーションを持てませんでした。
でもそれが最近、マニュアル作成のツールとプロセスを見直してSIOS Coatiの本体のコードを書くのと同じノリで作業できるようになったんです。

マニュアル作成はSphinxで、マニュアルのデプロイはBitbucket Pipelinesを使いました。

プロセスやツールの変更で楽しく仕事ができるようになるのは良いことです。

今、オンラインマニュアルはこのようになっています。

 

 

 

 

 

 

 

 

 

 

 

 

 

 

さて後編では具体的にどのように変えて作業効率をあげたのかを説明したいと思います!

SNSでもご購読できます。