都内SEのプログラミング勉強と雑記

2008年より都内でSEをしてます。業務システムをリプレイスし続けてきました。ここでは主にjavaやその周辺技術関連を紹介予定。学ぶことリスト:https://docs.google.com/spreadsheets/d/1G4lUqbHxsMf4PGgeRVe1ZL3JTOjlSTrqsJYe1CKz9UY/edit?usp=sharing

Excel方眼紙は嫌い?設計書(プログラミング)を何で書きますか

設計書(プログラミング)を何で書きますか

Excelでプログラミング設計書を書くことが2008年の社会人1年生の頃からずっと続いている。 色々な思いから代替案を探すけど、ずっといい解決案がない。

1案件だけ、技術紹介も含めて設計書参照用のサーバをプロジェクト内に立てて
markdown形式のテキストファイルで記載、というのを体験しました。

個人的にはExcel方眼紙というのも好きです。
楽だけど、やはりブックを開きすぎると重さを感じるし、100ファイル超えもざらにあるので
マクロでもなんでも全文検索は厳しい。

そこで以下使ってみました。

オンラインでのドキュメント制作・管理

・Growi

GROWI - 快適な情報共有を、全ての人へ

f:id:object1985:20200423170251p:plain

・Confluence atlassian

Confluence - 共同でより多くの成果を収める | Atlassian

f:id:object1985:20200423170355p:plain

1. Growi

GROWI は、WESEEK, Inc. が開発を行い、
MITライセンスで公開しているオープンソースソフトウェアです。

クラウド上に立てたサーバ内でmarkdownでのドキュメント作成・管理ができます。
markdownのテーブル表記のアシストが効いていて書きやすい。
また図の挿入にDraw.ioが連携でき、これもいい。
ただやはりExcelの図作成に比べれば遅いよね。。。あとグラフとか。。。
まあそこは今は割り切りかな。
そのうちWebが(HTMLが)進化するのを期待。

本記事下部「引用」に記載のQiita記事を元に
dockerで立てたローカルサーバで試しました。
とても簡単に立ち上げられる。
でもユーザ数による課金がネックになる?
(気前よく出してくれればいいけどExcelに勝てるか?)

2. Confluence atlassian

Confluence は、知識を集め、共同作業によって
素晴らしい成果を達成する
チームのワークスペースです。

これも操作は快適。
概ねGrowiと同じ?
atlassian製というネームバリューもあるので
ユーザ数が事足りれば採用しやすい?

諸々の所感

いずれも操作は快適。
文書を作る分にはWebも大分早くなったなぁ。

他、設計書で大切なことってなんだろってことでぱっと出たのはこんなです。

  • 表が書きやすい・編集しやすい・コピペしやすい
  • 画像の扱い
  • グラフ作成・挿入(Draw.ioなど外部連携とか?)
  • 印刷・納品・エクスポート・インポート
  • 検索(全文検索とか文書内検索とか)
  • テーブルデータのフィルター
  • やっぱローカルでもみたい、編集したい
  • 無料?安い?
  • いつでも見れる?サーバ落ちない?落ちたら代替手段ある?
  • GitHubとかのホスティングでもいいんじゃ?

いつか「これだ!」っていうのが出て解決するかな?

しかし今回、いつにもまして見ずらい記事だ・・・
完全に個人メモになってしまった。

引用

  1. Qiita の記事:Excel設計書を抹殺したくて4年前にWiki設計書を導入したら、意外とちゃんと開発回ってた話。
follow us in feedly