タグ

2019年7月26日のブックマーク (1件)

  • レビュー前に直して欲しい日本語の問題点8つ - Qiita

    私はウンザリしています。 「○○対応」は曖昧なのでやめてください。「○○を修正した」の方が直接的です。 こんな指摘を新人が入ってくるたびにコードレビューやドキュメントレビューで繰り返しています。どうも、プログラマー(と言うか理系?)には独特の言語文化があり、みんな同じような分かりにくい表現をしてしまうようです。 「レビューを依頼する前にこれを読んどいて!」と言える記事なりなりがあれば良かったのですが、良いものが見つけられなかった(ご存知なら教えてください)ので、とりあえずレビューでよく指摘する日語の文章の問題点や変な表現ポイントを列挙しました。 なお「コメントは必要十分な量を書く」「チケット番号やWikiのURLを書く」といった、良く知られた・日語に限定されない話題は省略しています。 1. 俗称を使わない・造語しない 製品名・機能名などは正式なものを使いましょう。大抵はUIなりマニュ

    レビュー前に直して欲しい日本語の問題点8つ - Qiita
    ymgn
    ymgn 2019/07/26
    都合よくコミットメッセージ・PRメッセージ・コードコメントに書く日本語だと解釈して勝手に納得して読んでたけど、たしかになんのことかわからないタイトルしてるな