タグ

基本的とエンジニアに関するotakumesiのブックマーク (1)

  • 読みやすいブログの書き方 | DevelopersIO

    渡辺です。 以前、JUnit実践入門を執筆した経験もあり、社内でもブログの文章が読みやすいと評価を受けています(内容はともかくw)。 折角なので、技術ブログを書くときに注意する点をまとめてみました。 はじめに結論を書く 一番大切なこと、それは結論を最初に書くことです。 エンジニアには時間ありません。 はじめに、何が言いたいか、何を解決するのか、そこを最初に書かないと、読んでて苦痛です。 回りくどかったり、話がブレブレだと最悪です。 「XXの時、解決するにはXXする」とか「XXについて一言でまとめるとXXです」など、最初にまとめを書きましょう。 見出しですべてを伝える意識を持つ 見出しは大切です。 見出しを追っていけば、内容が頭に入ってくるのがベストです。 「見出しをまとめてしまったら、文に書くことなくなった(´・ω・`)」となれば完璧です。 まさに今、蛇足しか書いてません(笑)。 短い文

    読みやすいブログの書き方 | DevelopersIO
  • 1