役立つリリースノートを書くプロセスの享受を学ぶ(1) Learning to Enjoy the Process of Writing Useful Release Notes役立つリリースノートを書くプロセスの享受を学ぶShwetha Madhan, VMwareJanuary 15, 2020ヴイエムウェア社、シュエサマッダン著2020年1月15日As an information developer at VMware, I write all kinds of technical documentation – including the Workspace ONE UEM release notes. To create these release notes, I pull together new feature blurbs crafted by other writers and consolidate all of them into a new document. When I took over this task a few releases ago, I observed a common pattern. All the “What’s New” blurbs had a classic stand-up language: “Added support for XYZ”, “Added X and Y field under Z”, and so on. I wondered — why? Why is the text treating me like a robot? Do real people talk like this? During a stand-up, it’s normal to talk directly about the code that is written, but that information isn’t particularly useful for the end-user. Stand-up verbiage only results in opaque, impenetrable content.ヴイエムウェア社の情報開発者として、私はあらゆる種類の技術文書を書きます-それには 作業領域の ONE UEM リリースノートも含みます。 これらのリリースノートを作成するために、私は他の著者によって手作業で丁寧に仕上げられた新しい機能自我自賛的広告を立て直して、そしてそれらのすべてを新しい文書に統合します。 私が2-3のリリース前にこのタスクを引き継いだとき、私は共通のパターンを観察しました。すべての何が起こっているのかの自画自賛には次のような古典的無駄な言葉が多いです。: 「XYZのサポートのために追加」、「Zの下にXとYを追加」など。 なぜか? 本文はなぜロボットのように私を扱っていますか? 実際の人々がこのように話をしますか?無駄口の間に、書かれた符号について直接話をすることは正常ですが、しかしその情報は特に最終利用者のために役に立ちません。 無駄口の無用の言葉の多いことは、ただ不透明な、靴の上から水虫を掻くような内容をもたらすだけです。