Edited at

Qiita記事を書くためのポイント

More than 1 year has passed since last update.


はじめに

社内でQiitaへの記事投稿を目的とした、もくもく会を開催するにあたり、

初投稿者に向けて、記事作成時のポイントや注意点を自分なりにまとめてみました。

(試しにスライドモードを試してみたかったという目的があったのは内緒です)



目次


  • 記事を書く目的

  • 作成のコツ

  • Qiita Markdown記法

  • 画像の挿入

  • コードブロック

  • codepen

  • 注意点(記述内容)

  • 注意点(画像やロゴ)



記事を書く目的


  • 他のエンジニアに同じ苦労をさせないため

  • 自分のノウハウを記録として残すため

  • 今までお世話になったエンジニア(ブログや記事)に対してのお礼

  • 保有スキルのアピール

一番の目的はアピール(忘れないようにするため)と思いますが、

同じ業界で苦労するエンジニアに対して有効となる情報を残しておく!

という意識を持つとモチベーションを保ちやすいです。

また、Qiitaのガイドラインに記載されてように、

プログラミングに関する再利用・汎用性の高い

記事を投稿するようにしましょう!



作成のコツ

記事作成時の画面に、

Qiita公式が用意してくれている良い記事を書くためには

というページに(別タブで)遷移します。

そのページに記載されている意識すると望ましいもの

内容を参考にすると良いです。


  • 具体的で簡潔なタイトルをつける

  • 環境や前提条件を説明する

  • 引用元や参考元へのリンクを書く



Qiita Markdown記法

基本的にはGitHubのMarkdown記法に似ていますが、

スライドモード等、Qiita独自のMarkdown記法が存在します。

詳しくは、Qiita公式がまとめたMarkdownチートシート記事を参照ください。



画像の挿入

添付画像が大きい場合は、imgタグを使うと良いです。

参考URLはこちらの記事です。


そのまま添付した場合

qiita-text.png


imgタグ使用時



コードブロック


test.rb

a = "bbb"

puts a if a.nil?

記事にコード挿入する記法のことです。

シンタックスハイライト可能な言語についても、

Qiita公式がまとめた記事があるので要参照。



codepen

Web上でHTML/JS/CSSを3要素を見ながら、

開発が行えるWebサービス。

Qiita記事の埋め込みが可能!

方法はこちらの記事から



codepenのサンプル表示

※スライドモードでは表示不可

See the Pen
bootstrap_sample
by zucky (@zucky_zakizaki) on CodePen.



注意点(記述内容)

みなさん認識されていると思いますが念のため。


  • 顧客や常駐先が特定できる情報は記載しない


    • IPアドレス、システム名称 等



  • いい加減な情報(嘘)は記載しない


    • 閲覧者に迷惑をかけてしまうため

    • 間違いに気づいた or 指摘いただいたら早めに修正すること





注意点(画像やロゴ)

こちらも認識済みと思いますが念のため。


  • 著作権フリーな画像を使用すること


    • IPアドレス、システム名称 等



  • ロゴの場合は規約に沿って使用すること





おわり