メインコンテンツへスキップ
見出し画像

ADR: よくある誤りと改善方法

    ADR を知識として理解していても、実際に書いてみると陥りがちな罠があります。ADRのレビューで繰り返し指摘される4つの典型的な誤りを取り上げ、それぞれBefore(悪い例)とAfter(改善例)の対比で示します。William Zinsserは名著『On Writing Well』の中で、明快な文章の最大の敵は「不要な言葉(clutter)」であると述べています。曖昧な修飾語、逃げ道を用意する表現、根拠のない断定──これらは技術文書において特に害が大きく、ADRの価値を根本から損ないます。過去示した5つのアンチパターンのうち、ここでは書き方のレベルで改善可能な4つを取り上げます。

     
     
    元IBMのSalesforceITアーキテクト。 ITアーキテクチャの深淵から、日々の何気ない生き様まで、思考の軌跡を「毎日」綴っています。 座右の銘は「人生即是遊戯」。 家族とPerfume、オーディオを愛する私の遊び場が、あなたの日常のちょっとした刺激になれば幸いです。

    あなたへのおすすめ