「分かりそう」で「分からない」でも「分かった」気になれるIT用語辞典イメージぴよ画像「分かりそう」で「分からない」でも「分かった」気になれるIT用語辞典

ドキュメントバグ

pointこの用語のポイント

point資料の書き間違いだよ

pointハッタリをきかせた表現だよ

スポンサーリンク

簡単に書くよ

ドキュメントバグ(英:documentation bug)とは

「やっべ!資料(仕様書とか設計書とか)に書き間違いがあったわ」的なことをカッコ付けて言った表現
です。


image piyo

詳しく書くよ

ドキュメント」+「バグ」で「ドキュメントバグ」です。

ドキュメントバグ

ドキュメントは「資料」ね。
今回は仕様書(完成形を説明した資料)設計書(作り方を説明した資料)のような「作るために必要な資料」のことだと思ってください。

ドキュメントバグ2

バグは「プログラムのおかしいところ」です。
バグがあるとプログラムは期待した通りの動きをしてくれません。
変な動きをしたり、作ったデータの中身が変だったり、途中で処理を止めたりします。
バグの程度にもよりますが、バグがあるプログラムさんはラリラリです。

ドキュメントバグ3

以上を踏まえて

「あっ、資料に書き間違いがあったわ。ゴメンね」な状態

をカッコ付けて言った表現が「ドキュメントバグ」です。

ドキュメントバグ4

例えば「ここで1秒待つ」を「ここで10秒待つ」と書いてしまったりするのがドキュメントバグです。
資料が間違っていたら当然できあがるプログラムも間違った状態になります。
そのような場合に「あ~、この原因はドキュメントバクですわ」と言ったりします。

身も蓋もない言い方をするとドキュメントバグは「書き間違い」です。
それだけです。

それでは、何故わざわざ「ドキュメントバグ」のような言い方をするのでしょうか。

それはハッタリが必要になる場面があるからです。

例えば、不具合が出て怒っているお客さまに「すみません。今回の不具合の原因は資料の書き間違いです(--;」とか言うと「そんな単純ミスが原因かよ!」と心証が悪くなるかもしれません。

ドキュメントバグ5

そんなときに「すみません。今回の不具合の原因はドキュメントバグです(--;」とか言ったりするのです。
そうすると少しだけ「うっかりミスだぜ」な印象が消えます。

ドキュメントバグ6

まぁ、つまり、悪あがきですね。

ちなみに「ドキュメントバグ」という言い方はローカルルールに近い表現だと思います。
私は少しだけ馴染みがありますが、お仕事現場の文化によっては通じないかもしれません。
ご注意ください。


image piyo2

一言でまとめるよ

まぁ「ドキュメントバグ」って単語が出てきたら「『資料に書き間違いがありました!』のことなんだな~」と お考えください。

一番上に戻るよ
スポンサーリンク
書籍画像017
書籍画像029

おまけ

■訳してみるよ

「document(ドキュメント)」の意味は「文書」とか「書類」とか「資料」とかです。
「bug(バグ)」の意味は「虫」とかです。
何となく くっつけると

資料の虫

となります。




書籍画像
わわわ説明術コラム
宣伝だよ
「分かった!」と思わせる説明の技術 知識ゼロの相手にも伝わるようになる本【Audible】
わかばちゃんとつくって、壊して、直して学ぶ NewSQL入門
サイバー忍者入門 忍者・スパイ・軍隊・ハッカーに学ぶ フルスタック・ハッキング