IT 余談

【いわゆる神エクセル?】システム開発の設計書を、エクセルで作ってしまう日本の悪習。設計書は、スリム構成、マークダウンで作るべき

投稿日:

こんにちは。

システム開発の際、ビジネスパートナー(SIerなどの外注先)との意思疎通に用いられる設計書

筆者の周辺だけの傾向なのかも知れませんが、本来、表計算ソフトであるはずのエクセルを使って、設計書を作るという文化ができている企業が少なくないと感じます。

市役所の帳票にはExcelで作成されているものがあり、見栄えを整えるためだけに、セル結合や罫線が多用された結果、本来の表計算ソフト(データ収集などの機械的処理)の利点が生かせなくなるという、いわゆる「ネ申エクセル」問題も発生しています。

本記事では、情報システム開発の現場で発生している「ネ申エクセル」問題に踏み込んだ上で、今後、日本のITエンジニアの目指すべき方向性について提言したいと思います。

「ネ申エクセル」問題によって、情報システム開発の現場に起きている問題

テーブル構造定義や要件一覧リストなどの「表」が多く含まれるという性質上、システムの設計書にエクセルが活用され始めたという推移は、容易に想像できます。

システムの設計書をエクセルで作ることによって、以下のような弊害が生じていると筆者は感じています。

■システムの設計書をエクセルで作ることの弊害

  • ドキュメントの再利用しづらさ(セル結合や参照式があれば、再利用は絶望的……)
  • エクセルの多機能さゆえ、「作成者」個人のスタイルが随所に盛り込まれてしまい、ドキュメント改版時、次の担当者が、不当な苦労を強いられながら加筆作業をする羽目になる
  • 見出し(h2, h3, h4)、箇条書き(li, ol)などのスタイルを強制適用する仕組みがないため、ドキュメント全体として見渡したときの統一感のなさが、読み手に負担となる

これらは(数多くある弊害の)一例にすぎません。

エクセルを使うことが非合理的であると(頭では)分かっていようと、多忙なエンジニアが改善業務を優先することは難しく、いつまでたっても断ち切られない「悪習」として根付いていくのでしょう。

設計書は本来、シンプルであるべき。設計書の品質と、システムの品質には、強い相関関係があるので

設計書を解釈するのがコンピュータであれば、どれだけ長かろうと、どれだけ複雑なパターン分岐があろうと、記載事項にミスがない限り、システムは欠陥ゼロで完成するでしょう。

実際には、設計書を手に取って読むのは人間であるため、プログラム完了時の品質は、設計書の良し悪しをダイレクトに反映したものになります(設計書の品質がショボいほど、納品されるプログラムの品質も低下するため、設計書の品質は、システムの品質と強い相関関係があると思います)。

エクセルを使って設計書を作ると、「弊害」でもあげたような問題が発生するため、読み手も書き手も消耗し、本来、品質を担保するために費やされるべきパワーが、おそまつな設計書の解読作業へ分散されてしまう結末が待っています。

逆の発想をすれば、効率よく情報伝達できる設計書の書き方スタイルを確立すれば、完成するシステムの品質も、うなぎ上りに上昇するでしょう。

このような観点で、設計書とシステムの品質について考えたとき、「ネ申エクセル」ってやっぱり是正されるべき問題だということになるのです。

構造化・細分化を意識した設計書づくりが、設計書の品質担保に貢献し得るという話

これまでを通じ、以下の3点について述べました。

■本記事のコアとなるポイント

  • 「ネ申エクセル」による設計書づくりは、いろいろな弊害がある
  • 設計書の品質とシステムの品質には、強い相関関係がある
  • 設計書の読み手は(コンピュータではなく)人間なので、設計書の内容は、極力シンプルに保つべし

本記事を締めくくる前に、もう少し深堀して、本来あるべき設計書の姿について論じておきましょう。

人間はミスをする存在です。

個人差はあろうと、書く側も、読む側も、ミスを犯す可能性をゼロにすることはできません

そこで重要となる、設計書作成上のキーワードは、構造化細分化の2点です。

本記事のテーマからはみ出るため、あまり詳しく論ずることはできませんが、骨子となるアイデアのみ記載します。

構造化について

ドキュメントの構造には、スタイル(h2, h3, h4, ul, ol)を必ず適用します。

また、一度決めたドキュメントの構造は、プロジェクトが終わるまで一貫して、すべてのファイルに対して適用することが重要です。

こうすることによって、書き手も読み手も、頭の中に「フレームワーク」が完成し、次にどのようなコンテンツを書くか(読むか)について、共通認識が形成でき、コミュニケーションミスが激減します。

細分化について

一つあたりのドキュメントに書く内容(のスコープ)を小さくすることも、検討しましょう。

たとえば、従業員マスタ情報のメンテ機能を作成する場合、設計書を以下のように4分割することで、(書き手にとって)記述スコープ、(読み手にとって)読解スコープが限定されることになり、成果物(設計書、ソースファイル)の品質を担保することにも寄与します。

■設計書の4分割を考えよう

  • 画面のレイアウトについての設計書
  • データベースアクセス(読込処理)についての設計書
  • データベースアクセス(書込処理)についての設計書
  • エラーハンドリング系(異常処理)についての設計書

一つの設計書で記載できるところ、四つもの設計書を作るなんて無駄だと感じるかも知れませんが、いちど騙されたと思ってやってみてください。

いろんなメリットを実感できると思いますし、一つの設計書にあれこれ詰め込むよりも、最終的には時間が短縮できることもあると思います。

エクセルよりは、マークダウン。良い設計書を作るための強制力にもなり得る

「ネ申エクセル」の話題に始まり、設計書の理想論(構造化・細分化)までお話しました。

本記事で書いたようなことを実業務で実践するには、エクセルではなく、マークダウンによる設計書作成を念頭に入れるべきだということを最後に付け加えておきます。

エクセルに慣れ親しんだエンジニアであるほど、マークダウンへの移行には抵抗があるかも知れませんが、構造化・細分化を意識してドキュメントを作るためには、マークダウンほど最適なツールはないと思うのです。

ブログランキング

(おしまい)

  • この記事を書いた人
  • 最新記事

Ajikichi

「美味しくなければ旅じゃない」が口癖。旨いものを求め、約三十か国を食べ歩く中で、台湾・ベトナムが誇る「感動的食文化」との運命的出会いを果たす。毎年、十回ほど「外食」と称して渡航。 仕事はエンジニアをしており、デザイン思考が気になる今日この頃。

オススメ記事

「韓国のマチュピチュ」こと、甘川文化村 1

目次1 はじめに:国内航空券よりも安い、釜山行きチケット2 「チョリャンミルミョン(草梁ミルミョン / 초량밀면)」地元の超人気店3 「甘川文化村」釜山のマチュピチュとも呼ばれるアート村4 「チャガルチ市場」飲ん兵衛のオアシス5 部屋呑み| ...

てへぺろ? 2

目次1 はじめに:朝の食事なら、萬華区(万華区)が良い1.1 なぜ萬華区(万華区)か?2 萬華区(万華区)エリアの朝食スポット5選2.1 「阿偉正宗咖喱飯」昭和の給食、素朴なカレー2.2 「周記肉粥店」オカワリ必至、おかゆがススム君2.3 ...

3

目次1 はじめに:数時間前まで「馬祖列島って何?」だった筆者が、出発を決意1.1 そうだ、「馬祖」行こう1.2 インターネット検索できないことだらけ。逆にそれって、チャンス?1.3 本記事のコンテンツについて2 馬祖列島を魅力的にする15の ...

家族団らん 4

目次1 はじめに:ハノイ随一のインスタ映えスポットとは?1.1 トレインストリートへの行き方1.2 本当にインスタ映えするのは「電車」ではない1.3 ハノイの「目覚め」2 「トレインストリート」訪問レポート2.1 「リビングルーム」になった ...

時空旅人 2018年9月号 Vol.45 [ 台湾 見聞録 ー 日本が残した足跡を訪ねて ー] 5

目次1 はじめに:ひさびさに「アタリ」の台湾特集誌が出たという直感でポチる2 【時空旅人 2018年9月号 台湾 見聞録】読書レビュー2.1 本書の構成スタイル2.2 日台ストーリの描かれ方2.3 「永久保存版資料」としての価値もある、【目 ...

6

目次1 午前六時台に、西門から街歩きをスタート2 「恋愛成就」の神様がいる廟、早朝から働いて暑さを回避する台湾の人々3 朝食は、外で買って食べることが浸透している「朝グルメ先進国」台湾4 めくるめくB級美食グルメに舌鼓4.1 「清粥小菜」| ...

暖色系のランプが照らす、薄暗い市場。地元の「すっぴん姿」、日常感が溢れる一コマ 7

目次1 台湾・板橋(バンチャオ)|グルメ食べ歩きの開始前に、市街地を観光2 台湾・板橋(バンチャオ)|「生炒魷魚」にて絶品グルメのイカスープに舌鼓3 焼き餃子、鍋にペタペタ貼って調理するから、中国語では「鍋貼」4 台湾・板橋(バンチャオ)| ...

図書館前の池に咲いていた花 8

目次1 台湾・北投(ベイトウ)|公私クサクサ、ちょっとした「傷心旅行」としてスタートした、ひとり温泉旅2 台湾・北投(ベイトウ)|「漢奇肉羹店」で全三種類の麺にトライ。すべてが「ナンバーワン」になる安定の美味しさだった3 台湾・北投(ベイト ...

-IT 余談

Copyright© アジアの何か。 , 2021 All Rights Reserved.