簡潔でわかりやすいドキュメントを書くときに最低限押さえておくべき4つのポイント

簡潔でわかりやすいドキュメントを書くときに最低限押さえておくべき4つのポイント

どんなエンジニアも、コードだけ書いていれば仕事になるわけではありません。プロダクトや技術について...概要を表示 どんなエンジニアも、コードだけ書いていれば仕事になるわけではありません。プロダクトや技術についてエンジニア同士で、あるいは専門外の人にわかりやすく伝えなければならない機会は多く、ドキュメントが必要な場合も多々あります。そうしたドキュメントを誰が読んでも理解できるものにするには、どんなことに気をつけて書けばいいのでしょうか。『技術者のためのテクニカルライティング入門講座 第2版』（翔泳社）から、4つのポイントを解説します。 本記事は『技術者のためのテクニカルライティング入門講座 第2版』（著：髙橋慈子）の「第2章　わかりやすく、簡潔な文章を書くテクニック」から一部を抜粋したものです。掲載にあたって編集しています。 一文一義で書く 1つの「主題＝伝えたいこと」に絞って書く 理解しやすい文章を書く基本のセオリーとして、テクニカルライティングでは「一文一義で書く」ことを基本として学びます。これは、