もはやこの時期しか書く気が起きないブログになってますが…
ちょっと思う所があって久しぶりに書く。
(日本で?)受託開発を続ける以上、切っては切り離せないものそれは納品物。
大体
今までドキュメントは作るとメンテ大変だし、何のために作ってるのかよくわからんしなーなんて思ってましたが、そういうわけにもいかず…
まあ百歩譲って書くのはいいけど、MS製品で納品しろって言われることがあるです。(余談ですけど、納品物って改変できていいんすかね?パスワードとかでロックするのが一般的?しらん)
なんでこれらの資料をExcelで書くことが面倒なのかってことを自分のまとめの為に書こうと思います。
※ ドキュメントを作るのがいやって言ってるわけじゃなく、用途不明/納品物としてしか機能しない意味がないものを作るのがいや、って言ってるだけです。あとExcelはディスってないです。すごすぎる製品です。
まあこの差分の話をするとそれwordでできるよって言われるまで経験済み。
必要な時にすぐ出せないのはかなりストレスだったりします。
まとめると
ってことなんじゃないかなーって最近思ってます。
いろいろ試行錯誤してるけど、gitbookとmermaidjsで試し中。
WEBは問題ないんだけど、gitbookでのPDF出力はpluginが対応しておらずmermaidjsが…
というわけで今準備中。そのうち公開します。
ちょっと思う所があって久しぶりに書く。
(日本で?)受託開発を続ける以上、切っては切り離せないものそれは納品物。
大体
- 基本設計(書)
- 詳細設計(書)
- インターフェース仕様(書)
- DB定義(書)
今までドキュメントは作るとメンテ大変だし、何のために作ってるのかよくわからんしなーなんて思ってましたが、そういうわけにもいかず…
まあ百歩譲って書くのはいいけど、MS製品で納品しろって言われることがあるです。(余談ですけど、納品物って改変できていいんすかね?パスワードとかでロックするのが一般的?しらん)
なんでこれらの資料をExcelで書くことが面倒なのかってことを自分のまとめの為に書こうと思います。
※ ドキュメントを作るのがいやって言ってるわけじゃなく、用途不明/納品物としてしか機能しない意味がないものを作るのがいや、って言ってるだけです。あとExcelはディスってないです。すごすぎる製品です。
差分がわかりにくい
端的に言えばplain/textで書いて、gitで管理してプルリク/マージしたいよねって話なんですよね。まあこの差分の話をするとそれwordでできるよって言われるまで経験済み。
検索しづらい
それできるじゃん。知ってる。やりにくい。必要な時にすぐ出せないのはかなりストレスだったりします。
Excelの表現力がすごすぎる
インストールされてない人はいない、文字、画像、リンク、オブジェクト(図形とか)、印刷レイアウトすらいじれるExcelはたしかにすごいんだけど- 画像の元ネタが行方不明になりがち
- Mac/WindowsのExcelって当たり前だけど別物なんすよねえ…
- 自由すぎて人によってレベルの開きが有りすぎる
- 直感的に作ることが容易過ぎる、その人がわかりやすい資料なだけ
- 方眼紙にしないといけない理由ってなんなん?あんまり作ったことない
まとめると
- 一発ものの案件だったら別に好きにしたら?
- でも受託開発で一回の納品で終わりって少ない、ないとは言わない
- つまり継続してソースも修正するし、継続して資料も修正しないといけない
- ということはだれでもメンテできないといけない
- Excelでの仕様書はメンテナンス性が悪すぎる。これに尽きる。
- たしかに記法はあるし、ある程度の知識は必要だけど、Excelの落とし穴に落ちるくらいならまだまし
- だれが作ってだれが読むのか、その読む人が必要な情報に過不足がないか。かつロールがごちゃ混ぜになってないか。
ってことなんじゃないかなーって最近思ってます。
いろいろ試行錯誤してるけど、gitbookとmermaidjsで試し中。
WEBは問題ないんだけど、gitbookでのPDF出力はpluginが対応しておらずmermaidjsが…
というわけで今準備中。そのうち公開します。