Bye Bye Moore

猫マンション建築の野望を胸に零細事業主として資本主義の荒波に漕ぎ出したアラサー男の技術メモ

【読書メモ】ドキュメント作成システム構築ガイド

ドキュメント作成システム構築ガイド[GitHub、RedPen、Asciidoctor、CIによる モダンライティング]

ドキュメント作成システム構築ガイド[GitHub、RedPen、Asciidoctor、CIによる モダンライティング]

githubやjenkins、AsciiDoctor、Redpenといったツールをつかって、
ドキュメントの作成を自動構築する本です。
最近手がけたプロジェクトでは山のように資料が作成され、
その結果言葉の定義が微妙に違ったり、数値が違ったりとわけのわからない事になりました。
わたしはGoogle Driveでやっていたのですが、パートナー企業は出力したwordやpdfで編集して、それを逐次反映するのは相当に大変でした。
内々の情報共有ならscrapboxという手段はありますが、
困った事にカッチリした資料様式に落とし込めないので結局二度手間になったりするのですよね……。

部分テンプレートのような運用をすれば、一部機能が変わっても動的に更新してくれるようになりますし
語句の乱れも一括強制で楽々。

さらに、図面の作成でもテキストベースでUMLを作成できる神ツールPlantUMLも利用可能となっています。
shuzo-kino.hateblo.jp


類似品sphinx

asciidoctorの類似品としてsphinxというのもあります。

shuzo-kino.hateblo.jp