タグ

writingに関するzyun1109のブックマーク (2)

  • 開発ドキュメントの書き方!9つのコツ【エンジニア】

    文章を書く前にやることよい文章を書くには、実際に文章を書く前に、読者は誰か、どういう悩みを解決するのかを企画することが大切です。また、それを元にアウトラインを書いておきます。 このふたつを元に文章を書くことで、読みやすい開発ドキュメントにつながります。これについては、次の記事をご覧ください。 開発ドキュメントを書く前に決めるべき3つのこと【企画編】開発ドキュメントにおけるアウトラインの書き方開発ドキュメントの書き方企画とアウトラインの作成が終わったら、実際に文章を書いていきます。文章を書くときは、次の9つを意識して書きます。これだけで、読みやすさ、分かりやすさが大きく向上します。 一文を短く切る結論を先に述べる指示語を使わない主語を明確にする、述語との距離を近づけるひらく・閉じるを統一する再現条件を示す前提を揃える見出しや箇条書き、表などを適切に用いる読者に伝わる用語を使うひとつずつ説明し

    開発ドキュメントの書き方!9つのコツ【エンジニア】
  • PREP法とは? 文章構成力を上げる3つの方法。SDS法・穴埋め文章作成法も | 次々に読まれる文章とは?

    次々読まれる文章の「文章構成」の実践編として、今回は具体的な3つの「文章構成のテンプレート」を紹介していきます。 テンプレートは、当てはめるだけで目的に沿った文章の流れができる「文章構成の型」です。構成が決まっていると、安心して「内容(メッセージ)」に集中できますので、あなたの文章クオリティアップにつながります。 テンプレートを具体的に解説する前に、テンプレートを効果的に活用するために必要な前提を共有させてください。 文章を書けなくしている「思い込みの罠」「文章は始めから、順番通りに書かなければならない」という思い込みは、ありませんか? もし、その思い込みを少しでもお持ちなら、すぐに捨ててください。「書き始め」から順番に書かなければならないと思っていると、手が止まり、文章自体が書けなくなってしまいます。 まず、ここで大前提としてお伝えしたいのは、「文章はどこから書いてもいい」ということです

    PREP法とは? 文章構成力を上げる3つの方法。SDS法・穴埋め文章作成法も | 次々に読まれる文章とは?
  • 1