僕のQuita記事を書くときのフォーマット

背景

• quita記事などを書く際に、「何から書き始めよう、、、」「構成をどうしよう、、、」と思ってしまうことはみんな経験してそう。
• 手前味噌ながら、僕が使っている記載フォーマットを紹介しようと思った。
• また、記事を書く際に僕なりに意識していることもシェアしてみたいと思った。

目標

• 僕がQuita記事を書くときに使用しているフォーマットを紹介する。
• 記事執筆をしているときに意識・工夫していることをシェアする。

僕が使用しているquita記事の構成フォーマット

• この記事そのままだが、僕の記事の構成は基本的には下記の５項目をベースに書いている。

項目	説明
背景	記事を書こうと思ったきっかけなど記載
目標	記事を読んだらできるようになることを具体的に記載
前提環境	使用している環境情報を記載
更新記録	日付と簡単な変更内容を記載
参考資料	お世話になった資料の皆様を記載

記事執筆が億劫にならないようにしている工夫

• この5つの項目が記載されたmdファイルをローカルに置いている。
• 記事を書くときはローカルファイルのmdを開いて、フォーマットをコピーしてから記事執筆をしている。
• いちいちフォーマットを手動で記載するよりは項目の設問に答えるイメージで書き始められるので記事執筆へのハードルが下がる。

記事の構成について考えていることなど

• 上記の5つの項目を構成のベースとして、この記事のように必要に応じて新しい見出しを入れている。

• 記事を書く時には自分が読み手であることを想定して、できるだけ文章は少なくするよう意識している。

• 僕的には、何か技術に詰まっている時にquitaを見ることが多いので、必要な情報さえあれば3行の記事でも価値を感じている。

• 逆を言えば、他のエンジニアもそうだと思っているので、スクール系の導入が多い解説とかはあまり書かないように意識している。

• 構成に、背景と目標を入れているのも、この記事を読めば何ができるようになるのか最初にわかるようになっていた方が技術的に困っている時は助かると考えているから。

• 一方で教科書的な体系的な知識を身につけたい時には、詳細に記述されたquita記事にお世話になっている。

• 上記のような詳細な情報を記述した記事にもチャレンジして行きたい。

• また、quitaのクスッと笑えるような話が入った記事も個人的には嫌いではない。

• ただ、余談が多くなりすぎると話が脱線してしまいそうなので、今のところては出せていない。

前提環境

• macOS 11.4 (20F71)
• arm64(M1)

参考資料

個人ブログ