Qiitaで記事を作成するにあたり
- 時間短縮
- 記事構成の統一
の目的のもと、テンプレート例を作成
テンプレ
コピぺ用
※ {記事タイトル}は、検索エンジンまたはQiita内での検索を考慮してキーワードを含めた命名を推奨。
# はじめに
なぜこの記事を書こうと思ったのか。
誰に向けた記事なのか。
# TL;DL
結論ありき
まず最初に一番重要な点を記述
読むのめんどくさいと思うので痒い所に手が届く簡潔な解説
ここを読んだだけで、何を言いたいのかがすぐにわかるように簡潔な記載
箇条書き〇
```:言いたいこと
- あれはこれです
- これはあれです
```:
# 前提
前提知識 => なしでも可
# 詳細
結論の内容を説明する詳細な内容を説明
番号付き見出しのまとめ
## 1. 詳細情報1
かくかくしかじかの説明
コードとともになら尚良しだが長くなりすぎるのに注意
## 2. 詳細情報2
かくかくしかじかの説明
コードとともになら尚良しだが長くなりすぎるのに注意
# 参考文献
- [リンクテキスト](URL)
- [リンクテキスト](URL)
- こっちにコードを用いた具体的な実装あってもいい
# その他部品
```言語名:ファイル名.拡張子
コードブロック
```:
[リンクテキスト](URL)
| No | 内容 | 備考 |
|---:|-------------|------------|
| 1 | | |
| 2 | | |
はじめに
なぜこの記事を書こうと思ったのか。
誰に向けた記事なのか。
TL;DL
結論ありき
まず最初に一番重要な点を記述
読むのめんどくさいと思うので痒い所に手が届く簡潔な解説
ここを読んだだけで、何を言いたいのかがすぐにわかるように簡潔な記載
箇条書き〇
言いたいこと
- あれはこれです
- これはあれです
前提
前提知識 => なしでも可
詳細
結論の内容を説明する詳細な内容を説明
番号付き見出しのまとめ
1. 詳細情報1
かくかくしかじかの説明
コードとともになら尚良しだが長くなりすぎるのに注意
2. 詳細情報2
かくかくしかじかの説明
コードとともになら尚良しだが長くなりすぎるのに注意
参考文献
その他部品
ファイル名.拡張子
コードブロック
No | 内容 | 備考 |
---|---|---|
1 | ||
2 |