3
0

Delete article

Deleted articles cannot be recovered.

Draft of this article would be also deleted.

Are you sure you want to delete this article?

More than 5 years have passed since last update.

Webシステム開発における、今だからこその「ドキュメント」の大切さ

3
Posted at

ドキュメントが嫌いなエンジニア、ベンチャー企業

 時々、「わかり易いコードを書けばドキュメントが不要」とかいう話を聞いたりもします。
詳細設計などについては確かに、変更も多いし、コードさえ読みやすければ、不要なドキュメントもあるかもしれません。

 情報の共有をコードにしろ、ドキュメントにしろ明確に、チームとしてここをみればいいというのがあればいいと思いますが、ただ怠惰の結果としてドキュメントがなく、後付的な「コード至上主義」は情報の共有を果たしているのか甚だ疑問です。

今の開発は細かく技術が分断している

 15年ぐらいまえは、サーバサイドの言語だけでいろいろ済ませることもできたかもしれません。
 翻って、2019年あたりのWeb開発はどうでしょうか?最近は、サーバサイド、フロント、インフラ、SaaSなど外部との連携など、フルスクラッチで少ない資源でシステムを作る時代ではないです。
 とにかく、いろいろな要素や職種の人が協力して一つのシステムを作り上げます。

 

技術や職種が分断しているときの「共通情報」としてのドキュメント

 コードをみればいいやというのは、リソースが少なければそれでいいかもしれません。
 ですが、現在のようにプログラム言語に関しても、いろいろ分断していたり、外部のAPIなどを使うようになると、ソースコードだけみていたらシステムの情報が分かるわけではありません。
 
 いろいろな要素や職種が連携すればこそ、母語や社内の共通の言語でかかれたドキュメントが必要になるのだと思います。

基本設計、外部設計などユーザー視点や共通情報は最低限ドキュメントにして共有する

 プログラムの中身についての詳細設計は変更しやすくドキュメントとして残すのがいいのかは疑問があります。
 ですが、基本設計、外部設計などユーザーさんの視点での機能仕様・画面仕様やシステム構成など全般に関係する情報はドキュメントとして決まったフォーマットで作成して、ユーザーさんやチームなどで共有すべきです。

 小さい会社とかフリーランスの人はこのあたりの整備ができておらず、「炎上」することもあるように見られます。

今いちどドキュメントの大切さを見直す

 本当は、時代を問わず、仕様書・設計書などのドキュメントは必要なのだけれど、今のWeb開発は今まで以上にその大切さがあると思っています。

 また、時代に即した設計書の内容も必要になってくると思います(APIとかSaaSの運用設計とか)。

3
0
0

Register as a new user and use Qiita more conveniently

  1. You get articles that match your needs
  2. You can efficiently read back useful information
  3. You can use dark theme
What you can do with signing up
3
0

Delete article

Deleted articles cannot be recovered.

Draft of this article would be also deleted.

Are you sure you want to delete this article?