行先ボードを開発中ですが寄り道します。
やらないといけないことがあるとやらなくて良いことをやりたくなるのが人間の性。
試験期間中に部屋の掃除がしたくなるアレです。
寄り道してしまいました。所要時間13時間。
行先ボード開発の見積工数は118.5時間。
何と勿体ないことを・・・。
とりあえず、言い訳をしておきます。
普段はEnterprise Architectを使用しているので
そこまでは感じなかったのですがさすがにドキュメント作成がしんどい。
クラス図書いてるあたりで吐きそうになりました。
- 差分とれないしエクセルがイヤ(この点はEnterprise Architectも同じだけど)
- 設計書ごとにツールが色々分かれるのもイヤ
- マークダウンで図書けるけど、細かい説明が書けないのがイヤ
- 詳細をマークダウンで書けるけど表が絶望的に書きづらい
設計書作成ツール。menDoc。
自分が使える範囲で使えれば良いのでかなり適当です。
menDoc → 由来：めんどくさいドキュメント。
ネーミングセンス・・・。
課題
- 設計書をマークダウンで書きたい（差分を取りたい）
- マークダウンで書くのは色々しんどい（表とか表とか表とか・・・）
- VSCode + Marmeidを使っていくつかダイアグラム書いたけど一々調べながらしか書けない
- VSCode + Marmeidでダイアグラムは書けるけど細かい説明が書けない
- gRPCを使うのでAPI仕様書いたけどほぼソースコードそのまま
- ソースコードとドキュメントの不一致
色々諸々。
GitHub
ソースコードはこちらからどうぞ。
- GitHubリポジトリ
https://github.com/zeikomi552/menDoc
イメージ
表に必要な情報入れたら、
マークダウンとひな形のコードを作ってくれるようなものを考えています。
仕様としてはものすごく簡単です。
- 画面のイメージ
- 自動生成したコードをVSCodeでプレビュー表示
-
VSCodeでHTML出力したもの(Class図の部分がコードで出力されてしまっている・・・)
menDoc-ClassDiagram -
VSCodeでPDF出力
menDoc-ClassDiagram
テンションが上がらないので
もっさりした見た目はテンションが上がらないので変更します。
デザインセンス皆無の僕でもそれなりの感じ。
マテリアルデザイン、ありがとう。
もうちょい頑張る
ER図も対応してみました。
色々欲が出てきます。
menDoc画面イメージ
VSCodeでプレビューを確認
VSCodeに貼り付けてER図を確認。
まとめ
うまく行けば
表を埋めるだけでソースコードの自動生成
が、実現できそうです。
寄り道で13時間のロス。意志薄弱。
おわり
コメントを残す