タグ

ドキュメントと文章に関するalcohorhythmのブックマーク (3)

  • テクニカルライティングの基本

    テクニカルライティングの基を学べます。サイボウズの新入社員向け研修資料です。業務マニュアル、報告書、仕様書、技術解説書などのドキュメントを書く機会がある方向け。 Twitter:https://twitter.com/naoh_nak 2023年度のアップデート版もあります:https://spe…

    テクニカルライティングの基本
  • 開発ドキュメントの書き方!9つのコツ【エンジニア】

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

    開発ドキュメントの書き方!9つのコツ【エンジニア】
  • うまい文章をラクに書くための「たったこれだけ」の工夫5選。 - STUDY HACKER(スタディーハッカー)|社会人の勉強法&英語学習

    「文章をうまく書くには、やっぱり訓練が必要……? でも面倒なことはしたくない」 「難しいことや特別なことをしなくても、文章力がアップする方法を知りたい!」 このような人に向けて、うまい文章をラクに書くための “ちょっとしたコツ” を5つご紹介します。メール、チャット、報告書など、あらゆるビジネスシーンで使えるものを集めました。誰でも簡単に実践できますから、読んだら “即” 使ってみましょう。 1. 一文を「短くする」だけ 仕事の情報は複雑で、文章にするとどうしても込み入ってしまうもの。もっとスマートに書きたいのに……と思うなら、「一文を短くするだけ」で効果的です。 数々のヒット作を生み出すコピーライターで、“端的に文章を書くプロ” である橋口幸生氏。同氏は、読みやすい文章を書くには、一文を40~60字以内にまで短くするとよいと言います。 これは、一文に書く内容をひとつに絞ると実現できるとの

    うまい文章をラクに書くための「たったこれだけ」の工夫5選。 - STUDY HACKER(スタディーハッカー)|社会人の勉強法&英語学習
  • 1