タグ

ブックマーク / qiita.com/potato4d (1)

  • Qiitaで技術系の記事を書く時に気をつけていること - Qiita

    技術系の文章を書く際、「ここを気をつけているだけである程度読みやすい文章となる」といったポイントをいくつかご紹介したいと思います。 はじめてQiitaに投稿する人や、そうではないにしても、文章の品質を気にされるかたの助けになればと思います。 文章外のコンテンツ編 サンプルコードはできるだけ豊富に用意しましょう。 Qiita記事は、いわばドキュメントなので、文章が重要であることは当然です。 しかし、わかりやすさで言えば、エンジニアではコマンドやソースコードのほうがわかりやすい場合も多々あります。 不要であればどちらかを読み飛ばすことも可能な上、片方ではしっくりこない人は情報を補完しやすいので、できるだけサンプルコードは豊富に用意しましょう。 サンプルコードが肥大化してきた場合、GitHubにおいてやるのも一つの手かもしれません。 日付は正しく記しておきましょう。 コメントより。 Qiitaの

    Qiitaで技術系の記事を書く時に気をつけていること - Qiita
    g08m11
    g08m11 2016/10/23
  • 1