当たり前の手順も書くべし - Qiita
言わずもがなだけど、あえて言語化しておくシリーズです。 このような手順を書くのは冗長だと思ったことはありませんか？ （※mvnはMavenというJava用プロジェクト管理ツールのコマンドです。他言語の人は適当に読み替えてください） もちろん、本番作業手順書などの厳格な文書なら当然書くでしょう。でも、GitレポジトリのREADMEのような内輪のドキュメントでは・・・: どのアプリでも Maven を使っていれば mvn deploy でコンパイルするに決まっている Maven を使っていることはファイル構成から一目瞭然 うちのチームに mvn deploy を知らないプログラマーはいない（知らねえ奴はモグリだ！） だから、あえて mvn deploy 以外の方法を取る場合のみREADMEに書いた方が経済的だと思ったことはありませんか？私はあります。 でも、やっぱり、当たり前の手順であっても、
レビュー前に直して欲しい日本語の問題点８つ - Qiita
私はウンザリしています。 「○○対応」は曖昧なのでやめてください。「○○を修正した」の方が直接的です。 こんな指摘を新人が入ってくるたびにコードレビューやドキュメントレビューで繰り返しています。どうも、プログラマー（と言うか理系？）には独特の言語文化があり、みんな同じような分かりにくい表現をしてしまうようです。 「レビューを依頼する前にこれを読んどいて！」と言える記事なり本なりがあれば良かったのですが、良いものが見つけられなかった（ご存知なら教えてください）ので、とりあえずレビューでよく指摘する日本語の文章の問題点や変な表現ポイントを列挙しました。 なお「コメントは必要十分な量を書く」「チケット番号やWikiのURLを書く」といった、良く知られた・日本語に限定されない話題は省略しています。 1. 俗称を使わない・造語しない 製品名・機能名などは正式なものを使いましょう。大抵はUIなりマニュ
1
リリース、障害情報などのサービスのお知らせ
最新の人気エントリーの配信
処理を実行中です
j次のブックマーク
k前のブックマーク
lあとで読む
eコメント一覧を開く
oページを開く
@tonluqclmlのマイページ - Qiita
