<第2回>設計書を何で作るか「ドキュメント形式」

EngineerLife

システム開発のドキュメント形式

第2回目では、システム開発において使用する(される)ドキュメント形式についてお話しします。私は業務系システムの開発を多く経験しています。なのでスマホアプリなどの開発との違いは認識していないのですが、おおよそ大きな違いはないものと考えています。

ドキュメント形式一覧

一般的に多く利用されているのはEXCEL/WORDだと思われます。実際、私の開発現場ではEXCELは必ず使用しています。

■EXCEL ≒ Google Sheets

ポイント

  • 使いやすさ: 誰でも直感的に使えるシンプルな操作性。
  • 多用途: データ管理、計算、分析、グラフ作成、プロジェクト管理など幅広く利用可能。
  • 強力な計算機能: 数百種類の関数で、複雑な計算やデータ処理が簡単にできる。
  • データの可視化: グラフや条件付き書式でデータを視覚的に表現しやすい。
  • 自動化: マクロやVBAで繰り返し作業を自動化できる。
  • コラボレーション: クラウドを通じてリアルタイムで共同編集や共有が可能。

保存形式 バイナリファイル or クラウド

■WORD ≒ Google Sheets

ポイント

  • 使いやすさ: 誰でも簡単に文書作成ができる直感的なインターフェース。
  • 多機能: レポート、手紙、契約書、パンフレットなど、さまざまな文書の作成が可能。
  • 豊富なフォーマット: スタイルやテンプレートを使って、プロフェッショナルな見た目の文書が簡単に作成できる。
  • 文書の編集と校正: スペルチェック、文法チェック、コメント機能などで効率的に文書を編集・校正できる。
  • デザインとレイアウト: 画像、図形、表、グラフの挿入が簡単で、見やすい文書が作れる。
  • コラボレーション: クラウドを通じて複数人でリアルタイムに共同編集やフィードバックが可能。
  • 互換性: PDFなど他のフォーマットへの変換が容易で、他のシステムやプラットフォームでも使いやすい。

保存形式 バイナリファイル or クラウド

■Confluence

ポイント

  • 使いやすいコラボレーション: チームメンバーがリアルタイムで共同作業でき、意見の共有やアイデアの整理が簡単に行える。
  • ドキュメント管理: 仕様書、会議の議事録、プロジェクト計画など、あらゆる情報を一元管理し、誰でもアクセスしやすい。
  • テンプレート: 使いやすいテンプレートが豊富にあり、素早く文書作成を始められる。
  • 検索機能: 強力な検索機能で必要な情報をすぐに見つけられる。
  • 統合と拡張性: Jiraなど他のツールと連携して、プロジェクト管理やタスク管理がシームレスに行える。
  • バージョン管理: ドキュメントの変更履歴を追跡でき、過去のバージョンに簡単に戻せる。
  • アクセス制御: ページごとに閲覧・編集権限を設定でき、情報の管理がしやすい。

保存形式 クラウド

GitHub Copilotの恩恵

それぞれのメリット・デメリットを考察する

■EXCEL ≒ Google Sheets

EXCELは表形式のセルを組み合わせ、様々なレイアウトの設計書を作成することができます。数式を利用した計算やセル参照、表の作成、複数シートの利用など、EXCEL誕生から30年以上経過する中、様々な機能が追加され、利用勝手の良いツールになっています。

ただし、EXCELはバイナリ形式でファイルに保存され、他のツールからデータを読み込めない設計になっています。また、EXCELアドインは動作が重く(EXCEL2013の1プロセス化が影響)なりがちでです。

AIに読み込ませることも2024年時点ではできず、できたとしてもセル配置のルールや意味を拾いきれないと思われます。AI全盛の時代なのでAIサポート(※)を受けられないのはかなりのデメリットです。セルごとにタグを付けることができるようになれば将来的にEXCEL回帰も十分に有り得ます。

※ ここで言うAI利用は部分的な利用ではなく、章立て・文脈・構成などを理解し、提案してくれるようなものを指しています。表データの分析などのAIはすでにEXCELで利用可能になっています。

■WORD ≒ Google Sheets

縦書き文書の作成に特化したツールになっており、文書の作成能力は高く、変更履歴の管理も容易です。上流工程の要件定義や基本設計で使われることが多いように感じます。これは作成者の年齢層が高いことが関係しているかもしれません。

図形・画像・グラフの挿入なども出来ますが、縦長・横長の混在(EXCELだとシート分割で可能)は苦手、数式は簡易的なものに留まり、EXCELのような複雑なものは利用できません。よって、使えるとしても上流工程の要件定義や基本設計に留まり、機能設計や詳細設計に使うには不向きです。

■Confluence

全てがクラウド(WEB)で完結しており、リアルタイムでの強力な共同編集機能があり、変更履歴の管理も容易です。Wikiの延長にあるようなツールと表現することもでき、様々なレイアウト表現が可能ではありますが、多少の学習コストが発生します。また有料ツールです。

幸いなことにプラグインを用いることで数式利用が可能ですが、一番のネックは完全クラウドのため、オフラインでの使用には向きません。

札幌在住エンジニア。JavaやPHPやWordPressを中心とした記事が中心です。

【SE歴】四半世紀以上
【Backend】php / java(spring) / c# / AdobeFlex / c++ / VB / cobol
【Frontend】 vue.js / jquery他 / javascript / html / css
【DB】oracle / mysql / mariadb / sqlite
【infrastructure】aws / oracle / gcp
【license】aws(saa-c03) / oracle master / XML Master / Sun Certified Programmer for the Java 2 Platform 1.4

Nobelをフォローする
EngineerLife
Nobelをフォローする

コメント

タイトルとURLをコピーしました