Qiita投稿時の意識していること

概要

Qiitaなどに投稿するときの自分が意識していることや、どうやって記事を書いているかを今回はまとめてみました。
気が向いたら追記するかも

記事の作成前の準備

• 記事を作成するときの意識する時にまず以下の点を考えます。
  • テーマを決める。
    • 記事にする内容を漠然とでもイメージする。
  • 記事の全体的な構成を考えます。
    • 概要にこの記事は何を表しているかを書くために何を書くか？
      • 概要を読んでどういう記事かわかるようにを意識します。
    • 前提条件になにがあるか？
    • 内容(実際にやったことを記載)
    • 必要に応じて考察や備考、注意点、参考文献など
      • 参考文献については引用するところでどこから？と記載すると同時に必要に応じて最後にまとめて記載します。
  • さらに詳細な内容として以下の点を考えます。
    • 前提条件はどこまで書くか？
      • OS,言語のバージョン,どのライブラリが必要かなど
    • コードを載せるとしたらどの部分を載せて説明をどう記載するか？
      • 関係する部分はどのあたりか？
      • 説明をどの範囲で挟むべきか？

記事の作成

• 記事を作成するときはまずは思うままに記載していきます。
• 結論まで記述した後全体を以下の観点で見直します。
  • 説明が通っているか？
  • 補足が何か必要か？
  • 語尾が統一されているか？
• 記事をまとめた後時間をおいて読み直します。
  • 可能であれば1日おいて文章が通っているかを見てみるとおかしいところに気づけます。
  • または逆から順に読んでいってつながりがどうかを見るなどしてみます。

心構え

• 心構えと書くと大げさですが以下の点を考えて記事を書きます。
  • 少しぐらいおかしいところは気にしない。
  • 何か突っ込まれてもそれは改善できる機会としてとらえる。
  • 反響がなくても気にしない。
  • とりあえずやってみる