はじめに
こんにちは、（2021年）新卒で入社した企業で自社パッケージの開発を行っているエンジニアです。
これからQiitaで記事を書いていこうと思うのですが、Markdown記法の書き方や記事の構成/ルールをある程度決めておいた方が後で自分で見返す時も統一された記事になっており、わかりやすいかなと思いましたのでまとめておきます。
これからQiitaで記事を書こうと思っている方、Qiitaの記事を統一して、わかりやすくかつ効率的に記事作成をしていきたいと思っている方の参考になれば嬉しいです。
Markdown記法の記述方法
※具体的な記述方法は画像を参照してください
よく使う基本的なもの
見出し
「#」を使用します。#の数が少ないほど文字は小さくなります。
表テーブル
以下画像参照
段落
-（ハイフン）を使用します。
文字色の変更と強調
文字色の指定には<font color="red">テキスト</font>を使用します。
文字の強調には**テキスト**を使用します。
リンクの埋め込み
以下画像参照
画像のアップロード
載せたい画像をドラッグ&ドロップするだけでアップロードすることができます。
コードの挿入
エディタで記述したように表示したい場合
以下画像参照
color
横に色が表示されます。
記事の構成
記事の流れ
1.はじめに
2.具体的な記事内容
3.まとめ
4.あとがき
各フェーズの内容
はじめに
前置きで、このテーマにした理由やきっかけを記載します。
具体的な記事内容
具体的な内容を記載します。
何が原因で、何が起こったか、そしてどうやって解決したかなど内容の流れに気をつけながら記載していきます。
まとめ
具体的な記事内容をある程度要約した内容で記載します。
僕自身、ブログなどを見る時にめんどくさくなって「まとめ」セクションまで飛ばして、結果だけを確認する時が多々あるからです。
あとがき
「具体的な記事」セクションで書ききれなかった内容や最後の締めの言葉を記載します。記事を書く中で参考にした記事やサイトがあればここに記載します。
記事作成の流れ
1.日々記事ネタをメモしておく
2.記述する記事テーマ選択（1で書いておいた記事ネタの中から需要が高そうなもの）
3.記事内容の大枠を決める
4.大枠に沿って、記事内容を記載していく
5.投稿！
#ルール
記事を作成する上である程度、統一性を持たせるために気をつけておくことやルールを決めておきます。
タイトル
- タイトル名の先頭に【】を付け、その中にどういった人に向けてかどういった場合に必要になる記事かを短く記述する
- 自分用に備忘録をしておく場合はタイトル先頭に【備忘録】とつけておく
記事
- 1テーマに対して1つの事象にする（複数の事象を書くとわかりづらい）
- 原因と結果は（なるべく）横揃えにする
- 操作方法等を記述する際は画像を入れる
- 記事内で言葉は揃える
- ×「Visual Stadio CodeとVSCode」
- ◯「VSCodeで統一」
記事ネタ
日々、共有したいことやメモに残しておきたいと思ったことがあれば、スプレッドシートに残しておきます。そうすることによって、記事テーマの選択に時間がかからずに記事作成にうつることが出来ます。僕は以下画像のように記事のネタになる内容を保存しておき、優先度「高」のものから投稿していこうと考えています。参考までに。
あとがき
最後までご覧いただきありがとうございました。
皆さんの助けになればと、これからぼちぼちと投稿していこうと思いますので記事が少しでも良いと感じていただけましたらLGTMを押していただけますと幸いです。それでは、また！
参考記事
-
Markdown記法の記述方法
-
記事の構成