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

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

[masutaro]

はげしく同意なエントリだった。自分も文章書く時同じようなところに気を配ってる。この話題を肴に1〜2時間は語れそうｗ 本題と少しそれるけど、自分は「是非」は「ぜひ」って書く。

[shinyorke]

漢字、とくに「ひらき」は時折やらかすので気をつけたい←

[tagomoris]

elasticsearch vs Elasticsearch vs ElasticSearch vs Elastic search

[kuenishi]

漢字編、意味に合う字を利用すべきってだけでは。あと私は平仮名が多いとゲシュタルト崩壊して読みにくいので漢字が多い方が読みやすい。それから「技術の名前」は、アルファベットを正しく綴ろうというだけの話

[UDONCHAN]

ある

[efcl]

技術文章書くときの話。 まあ機械に怒られて直すぐらいがいい

[koogawa]

"iOS10" って表記も毎回直したくなる

[potato4d]

かいた