[フレーム]
はてなブックマークアプリ

サクサク読めて、
アプリ限定の機能も多数!

アプリで開く

気に入った記事をブックマーク

  • 気に入った記事を保存できます
    保存した記事の一覧は、はてなブックマークで確認・編集ができます
  • 記事を読んだ感想やメモを書き残せます
  • 非公開でブックマークすることもできます
適切な情報に変更

エントリーの編集

loading...

エントリーの編集は全ユーザーに共通の機能です。
必ずガイドラインを一読の上ご利用ください。

タイトルガイドライン

このページのオーナーなので以下のアクションを実行できます

タイトル、本文などの情報を
再取得することができます
コメントを非表示にできます コメント表示の設定

ブックマークしました

ここにツイート内容が記載されます https://b.hatena.ne.jp/URLはspanで囲んでください

Twitterで共有

ONにすると、次回以降このダイアログを飛ばしてTwitterに遷移します

548users がブックマーク コメント 128

ガイドラインをご確認の上、良識あるコメントにご協力ください

0 / 0
入力したタグを追加

現在プライベートモードです 設定を変更する

おすすめタグタグについて

よく使うタグ

プログラマーがドキュメントを書かない理由

548 users itnews.org

ガイドラインをご確認の上、良識あるコメントにご協力ください

0 / 0
入力したタグを追加

現在プライベートモードです 設定を変更する

おすすめタグタグについて

よく使うタグ

はてなブックマーク

はてなブックマークで
関心をシェアしよう

みんなの興味と感想が集まることで
新しい発見や、深堀りがもっと楽しく

ユーザー登録

アカウントをお持ちの方はログインページ

記事へのコメント128

  • 注目コメント
  • 新着コメント
Magicant
訳が所々怪しいのはともかく、ドキュメントを書くのがコーディングよりずっと難しいのは事実

その他
enhanky
外部仕様はユーザーマニュアルとして書いとけ。内部仕様はコードに丁寧なコメントつけとけばまあ困らない。コードはドキュメントなので。

その他
satorhyum
プログラム書くのは楽しいけどドキュメント書くのはめんどくさいからだよ(本文読んでない

その他
atsushifx
プロジェクトにドキュメントを書く時間をとってあるか?

その他
degucho
コードは全てを表してるので必要なのはなぜこの仕様になったかという経緯ですよ

その他
hiro_curry
プログラムの動きを説明するのにベストな言語はプログラミング言語だからね。

その他
nearlyinhuman
SIerをバカにする割にはこういう作業を避けるんだよなぁウェブ系エンジニアは... ITのことわからない別業種の人に説明できるから彼らが仕事取ってくるんだろうに

その他
imwks
例えがアレだけど、英文を完全に日本語訳できないしね。ニュアンスは伝わるけど細部に渡って翻訳しても意味がわからなかったりする。プログラムにおけるドキュメントもそういう感じはする

その他
satoko_szk
ドキュメント、書くよ? ソースコードは、例えるなら、表札までわかるレベルまで拡大した地図。市区町村レベルで俯瞰して方式検討する必要のある時もあるので、必要に応じて必要なレベルのドキュメントを用意する。

その他
yarumato
"文書記述はプロセスの一部になるべき。有効だった施策:コードを書く前に(自分が何をしようとしているのか)書く。実際の実装を詳細に説明せず、選択事項とその理由を説明する。検索可能にする。変更を追跡する"

その他
tmurakam
ドキュメント書く能力とコードを書く能力には結構相関があると思ってる。有能なプログラマはだいたいドキュメント書くのもうまい。逆にドキュメント書けないプログラマのコードはだいたいひどい。

その他
Amigomr
「ドキュメント」の定義がわからんが、設計書もなく(あってもメンテされておらず)、コードにコメントも一切ない状態で、過去のコミットログやチケットから経緯を探る考古学的作業を減らすべきというなら同意する

その他
rryu
関数やメソッドレベルのドキュメントのことならコード見るだけで終わるという矛盾を抱えつつ「この表現で繰り返しと気付いてもらえるだろうか」みたいな謎の苦労をするところだと思う。

その他
threetea0407
> 複雑なコードにコメントを求めても無駄(略)。なぜなら、コードで明確に表現できなかった人たちに、今度は英語で明確に表現することを期待しているからです。

その他
btron
そもそもちゃんと設計してなくて、流れで書く人が結構いるので、コード自体がドキュメントにしにくいものになってると言うのもあるかな。大体、きれいにドキュメントやコードを書いてもそれ自体は評価されんし・・。

その他
Keisuke69
そりゃ単純にコードだけ書いてたいからじゃないの

その他
frontline
場合によっては食事の方法を教えるのに文章で箸の持ち方から書かないといけない、みたいな難しさは有ると思う。

その他
i-think-so-too
書けないだけなのに(あえて)書かないと言いわけする人も多い

その他
sjn
ドキュメントを正しく評価してるのかは気にしてる。最近特に思わされることが多い。

その他
harumomo2006
勝手にコロコロ仕様を変えられて編集が追い付かないんだよ

その他
capriccio-bwv-993
プログラム自体がドキュメントだからです ( ́・ω・`)

その他
yoiIT
雰囲気でプログラム書いてるやつはドキュメント作れないよね。

その他
mysql8
歩く仕様書と呼び給え

その他
TokyoWorker
プログラマーじゃなくても、設計業務してる人全員に共通の考え方

その他
fikah
ドキュメントはどれだけ頑張って書いても絶対に後々更新されなくなって腐るから書く気がおきない

その他
w1234567
良いドキュメントを書くためには相手の気持ちを想像する力が必要なんだけど、そういう能力が未熟もしくは欠落してる奴がプログラマーになるからだよ

その他
kotaponx
書いても誰も読んでくれないけどね。まぁ、ドキュメントは保守する未来の自分の為に書くのだけど。

その他
alt-native
仕様を言語化できない人が プログラミングできるわけない。面倒なのは 顧客に提出するために、そのドキュメントの体裁を整えること。それはエンジニアじゃなくたって面倒。

その他
murasen
第2弾はマネージャがドキュメントを書かせない理由で頼むな

その他
nearlyinhuman
nearlyinhuman SIerをバカにする割にはこういう作業を避けるんだよなぁウェブ系エンジニアは... ITのことわからない別業種の人に説明できるから彼らが仕事取ってくるんだろうに

2021年06月04日 リンク

その他
Dragoonriders
なぜこう実装したかなんて仕様とユースケースを網羅した上でその軽重を見てこうしようって判断したかを書かねば意味ないのだから、はっきり言ってめんどくさいんだよ。どこかパラメータが変われば全部変わるのでな。

その他
nida3001
ドキュメントを書くのは本当に難しいしツラいお仕事なので、ドキュメント有害論が人気を集めてしまうわけよ。

その他
burabura117
コードが全てを表しているからドキュメント書かないみたいなコメントがスターを集めてて恐ろしくなった

その他
ntstn
コードはドキュメント。必要なら設計者が作るといい。

その他
hayashikousun
工数見積もりの時にドキュメントを書く時間を誰も計算に入れていないのが最大の理由。

その他
question20170711
プログラマーに関わらずドキュメントを残すのには一種の才能が必要だと思う。

その他
tianbale-battle
ソースに書いてるものをわざわざ文章で書きたくない気持ちは超わかる。ドキュメントが全ての現場で必要かと言われると微妙だけど、作らないならソースの管理だけはちゃんとやってほしい。

その他
napsucks
書いたものがドキュメントなんだよ!

その他
TETOS
金にならないから

その他
dollarss
"なぜなら、明確に書くことが本当に本当に難しいからです。"こう明記してくれると救われた気持ちになるね。だって本当に難しいもん...

その他

注目コメント算出アルゴリズムの一部にLINEヤフー株式会社の「建設的コメント順位付けモデルAPI」を使用しています

リンクを埋め込む

以下のコードをコピーしてサイトに埋め込むことができます

プレビュー
アプリのスクリーンショット
いまの話題をアプリでチェック!
  • バナー広告なし
  • ミュート機能あり
  • ダークモード搭載
アプリをダウンロード

関連記事

usersに達しました!

さんが1番目にブックマークした記事「プログラマーがド...」が注目されています。

気持ちをシェアしよう

ツイートする

プログラマーがドキュメントを書かない理由

この記事は、著者の許可を得て配信しています。 Why programmers don’t write documentation 最近ではず... この記事は、著者の許可を得て配信しています。 Why programmers don’t write documentation 最近ではずっとコードのドキュメンテーションに関連した記事を書いていたので、当然、私のMediumのおすすめ記事には「開発者がドキュメントを書かない当の理由」という記事が表示されるようになりました。この記事では、ドキュメントを書くための優れたツールがないことが、ソフトウェアエンジニアが自分の作業や判断をドキュメンテーションする意欲を失わせる最大の原因について書いています。 私は普段、特定の記事を批判したりはしませんが、この記事には怒りを覚えました。このライターは図解ツールについていくつかメリットに関して述べてはいますが、全体的に誤解を招くような内容になっており、この重要な問題をより分かりにくくさせています。2つの図解ツールを比較して、どちらも不十分なツールである

ブックマークしたユーザー

  • hotmilkcocoa2025年05月30日 hotmilkcocoa
  • mayu_01212025年03月13日 mayu_0121
  • ularaka2025年03月11日 ularaka
  • techtech05212024年04月23日 techtech0521
  • knj29182023年07月15日 knj2918
  • taka-oh2022年10月01日 taka-oh
  • wate_wate2022年08月05日 wate_wate
  • mjtai2021年07月12日 mjtai
  • heatman2021年07月04日 heatman
  • hnishi25092021年06月30日 hnishi2509
  • nadaredana2021年06月28日 nadaredana
  • J1382021年06月18日 J138
  • shimbaco2021年06月12日 shimbaco
  • S642021年06月12日 S64
  • haranicle2021年06月12日 haranicle
  • ofsilvers2021年06月12日 ofsilvers
  • kawasin732021年06月12日 kawasin73
  • shigeaki1jp2021年06月12日 shigeaki1jp
すべてのユーザーの
詳細を表示します

ブックマークしたすべてのユーザー

同じサイトの新着

同じサイトの新着をもっと読む

いま人気の記事

いま人気の記事をもっと読む

いま人気の記事 - テクノロジー

いま人気の記事 - テクノロジーをもっと読む

新着記事 - テクノロジー

新着記事 - テクノロジーをもっと読む

同時期にブックマークされた記事

いま人気の記事 - 企業メディア

企業メディアをもっと読む

はてなブックマーク

公式Twitter

はてなのサービス

Copyright © 2005-2025 Hatena. All Rights Reserved.
設定を変更しましたx

AltStyle によって変換されたページ (->オリジナル) /