gitbookで設計書を作成したら最高だった話 - フォトシンス エンジニアブログ

こんにちは。Akerunエンジニアの @ishturk です。 Akerun Advent Calendarの記事です。 今日は設計書の話です。 設計書をどんなツールで書くかは、僕らソフトウェアエンジニアの尽きない悩み（楽しみ）ですね。 最近はまったツールが最高に良かったので紹介させてください。 僕のツールに求める要件は以下です。 編集がカジュアルにできる UMLが書ける。あとから編集できる（画像での貼付けは編集できないのでNG） バージョンの管理ができる 好きになれる（重要） 変遷と pros/cons MS Word pros 良くも悪くもスタンダードなツールですね。 だれでも編集できるのが強みです。 Visioと組み合わせれば、UMLも後から編集可能です cons Visioは標準にするには少々値が張ります。 バイナリ形式なのでバージョン管理はしづらいです。 ページが増えたり画像を貼

[SnowSwallow]

asciidocのほうが、やれることは同じでマークダウンの表現力がより豊かじゃないかな。いずれにしても次の課題は、巨大なテーブル表現が苦手なこと。可視性・メンテ面でどうしてもエクセルに軍配が上がりがち。

[su_zu_ki_1010]

この手のは画面設計書で画面イメージを貼りたいときや、テーブル更新に絡む部分などを表現したいときにどうしても壁に当たってしまう。みんなどうしてるんだろう？

[take_she12]

これはword撲滅への新たな希望だ、試そう

[braitom]

MkDocs(http://www.mkdocs.org/)ではダメなのだろうか？

[richard_raw]

Sphinxみたいなの。/「SUMMARY.md」にファイル単位の文書構造を書くんですね。

[tlync]

gitbook よさそう。Wiki だとコードとライフサイクルと分断されてるのでどうしても乖離が発生する。その点、git 管理だとコードと一緒に PR 出せたりするので風化しにくいという実感はある。流動的な情報には向かないけど

[otihateten3510]

あ、gitとは関係ないのか

[kithzmky]

gitbook ドキュメント 開発 設計書

[sigeharucom]

md滅びてadocな世の中になって欲しい

[tettekete37564]

“gitbook”,“sphinx”

[h5y1m141]

GitBookのPlantUMLのプラグインあるの知らなかった。

[rryu]

肝心の図はplantuml頼みっぽいが、他の形式もプラグインでなんとかなるのだろうか。

[ryonext]

“、”

[wordi]

gitbook便利そう。markdownを編集し、デプロイ先のブラウザで表示してるHTMLもリアルタイムに変更されて確認出来る、らしい

[hyperpeppy]

pdfにできるのもいいよね。フォント指定すれば太字とかも反映されるし、見栄えもいい。

[iwanofsky]

ほうほう、

[masa-wo]

hu-mu

[alastor914]

実践したい・・・！！！