はじめに
Qiitaで記事を書く際に毎度構成を考えていたので、先人たちの書き方を参考にQiitaを書く際の見出しをテンプレ化しようと思います。
今後テンプレートを使う中で随時更新していきます。
テンプレート
テンプレートといっても内容に応じて使い分けた方が良いと考えます。
まずはパッと思いついた以下についてテンプレート化します。
このテンプレートも今後ブラッシュアップしていく予定です。
- 新しい機能の説明記事
- エラーの対処法記事
新しい機能の説明記事
## はじめに
- 記事の概要
- 記事執筆の背景
- 想定読者
## 実現したいこと
- ほげほげする
## 前提
もしあれば
## 開発環境
- ツールの説明
- 注意事項
## セットアップ
- 開発環境のセットアップ方法
## 使い方
使い方
## デモ
もしあれば
## 終わりに
- 感想
- 懸念点
- 考察
## 参考
- hogehoge
エラーの対処法記事
## はじめに
- 記事の概要
## エラー内容
- エラー文コピペ
- エラー内容概説
- エラー文が英語であることが多いため
## 試したこと
- 省略しても良い
## 原因
- ほげほげ
## 解決策
- ほげほげ
## 結果
- ほげほげ
## 終わりに
- 感想
- 考察
## 参考
- hogehoge