はじめに
勉強したことをQiita記事として残す習慣をつけたいと思い、Qiita投稿を始めました。
せっかく書くのだから、わかりやすい記事にしたいですよね?
...でも、毎回構成を考えるのは面倒。
そこで、「とりあえずこれをコピペしてから書き始めればOK!」というQiita記事投稿テンプレートを作成しました。
対象者
この記事は下記のような人を対象にしています。
- 駆け出しエンジニア
- プログラミング初学者
- 文章の構成を考えるのが面倒な人
- 初歩的な内容の記事を書きたい人
結論
このQiita記事投稿用テンプレートをコピペして記事を書き始めるだけでOK!
Qiita記事投稿用テンプレート全内容
## はじめに
## 対象者
この記事は下記のような人を対象にしています。
- 駆け出しエンジニア
- プログラミング初学者
## 結論
## 段落
### 詳細
## おわりに
についてまとめました。
## 参考記事
[リンクタイトル](url)
## その他部品
```php:example.php
コード
```
| No | 内容 | 備考 |
|---:|-------------|------------|
| 1 | | |
| 2 | | |
Qiita記事投稿用テンプレート各項目解説
はじめに
「なぜこの記事を書いたのか」を端的に書きましょう。
**「あ、この人も同じことで悩んでたのね、そしてそれを解決したのね!」**ということが分かると安心して読み進められるため、出来るだけ書くようにしています。
対象者
「はじめに」とおなじで、**「これは自分向けの内容だな」**と思えることが大事なので、書くようにしています。
結論
プログラマーは上から順番に文章を読む人が多いような気がします。
そのため、結論はできるだけ前半に書くようにしています。
段落・詳細
ここまで読み進められた人は具体的な内容を知りたいはずです。
実際のコードなども提示しつつ、わかりやすい説明を心がけましょう。
おわりに
これはなくてもいいかと思いますが、記事のまとまり的に所感みたいなものがあってもいいかと思います。
参考記事
参考にした記事は感謝の意味も込めて、きちんと掲載するようにしましょう。
自分の記事が参考にされることもあるかもしれませんね!
今回記載しなかった項目
下記の項目はもっと上級者向けの記事の場合には必要になると思います。
- 開発環境
- セットアップ
- 使い方
- デモ
...が、私のような初心者が調べてまとめるような記事には不必要なので省略しました。
おわりに
駆け出しプログラマー向けのQiita記事投稿用テンプレートについてまとめました。
**「自分のためにまとめたテンプレ、もったいないから公開しよ!」**という軽い気持ちで書き始めましたが、記事になるとそれなりに達成感がありますね。
今後もこのテンプレートを使ってどんどん投稿していこうと思います!