Qiita記事の書き方テンプレート|LGTM構成
なぜ「テンプレート」で書くと読まれやすいのか
Qiitaで読まれない記事の多くは、内容が悪いのではなく「何を解決した記事なのか」が冒頭で伝わらないことが原因です。読者の多くはエラー名や技術名で検索して流入し、最初の数行で「自分の問題が解決しそうか」を判断します。決まった構成(テンプレート)に沿って書くと、この判断を助けられます。
テンプレートのもう一つの効能は、書く側の負担が減ることです。毎回ゼロから構成を考えず、空欄を埋める感覚で書けるため、投稿のハードルが下がり継続しやすくなります。
そのまま使える基本テンプレート
筆者が普段使っている章立ては、次の6ブロックです。技術記事(特に「やってみた」「ハマった」系)に幅広く使えます。
# タイトル(具体的に。技術名+やったこと+結果)
## 背景・課題
なぜこれをやったか。誰のどんな困りごとか。
## 環境
OS / 言語・フレームワークのバージョン / 主要ライブラリ
## 手順
1. ...
2. ...
(コードは動く最小単位で)
## 詰まった点と解決
エラー全文 → 原因 → 対処
## まとめ
得られた結論。次にやること。
## 参考
公式ドキュメント・引用元のリンク
各ブロックのポイント
- 背景・課題:「業務でCSVを毎日手作業で集計しており、自動化したかった」のように、読者が自分ごと化できる一文を置く。
- 環境:再現性の要。バージョン違いで動かないのはよくある躓きなので、必ず明記する。
- 手順:コピペで動く最小コードを心がける。省略する場合は「ここは省略」と明示。
- 詰まった点:実はここが一番感謝されやすい。同じエラーで検索した人が直接たどり着く。
冒頭文の例(出だしで離脱させない)
タイトル直後の数行は特に重要です。次のような型が使いやすいです。
「○○を導入したところ△△というエラーで動かず、解決まで小一時間かかりました。同じ状況の方向けに、原因と対処を最小手順でまとめます。環境は□□です。」
「何をして」「どうなって」「この記事を読むと何が分かるか」を1〜3文で示すのがコツです。期待値を先に揃えると、最後まで読まれやすくなります。
タグは検索流入の入口
Qiitaのタグは、記事の発見されやすさに直結します。次の点を意識すると無駄が減ります。
- 言語・フレームワーク・主要ライブラリ名を正確に(表記ゆれに注意。例:
Node.js)。 - 大きすぎるタグだけでなく、具体的なタグも混ぜる(例:
Pythonに加えpandas)。 - 記事内容と無関係なタグは付けない。流入しても離脱が増えるだけです。
5個程度を上限の目安に、関連度の高い順で選ぶと過不足が出にくくなります。
公開前のセルフチェック
- タイトルだけで何の記事か分かるか。
- 環境(バージョン)を書いたか。
- コードはコピペで動くか、動かないなら断り書きがあるか。
- エラーは全文を載せたか(検索に引っかかる)。
- 参考リンク(公式優先)を付けたか。
このチェックを通すだけで、後から「情報が足りない」と指摘される率が下がります。
ちなみに筆者は、この構成チェックやタイトル案出しの手間を減らすために、Qiitaの執筆画面に補助サイドバーを足す非公式・個人開発のChrome拡張「Qiita-AI+」を自作して使っています。タイトル候補やLGTM予測、章立て、タグ最適化、読みやすさ評価といった機能を無料で毎日使え(回数上限あり)、無制限にしたい場合はPro(¥980/月)があります。設計はBYOK方式で、自分のClaude/OpenAIのAPIキーを使い、本文やキーは運営サーバーに送らずローカル保存される作りです。あくまで下書きの補助で、内容を作るのは自分です。
まとめ
「背景→環境→手順→詰まった点→まとめ→参考」の型と、正確なタグ付けを習慣にするだけで、記事の再現性と発見されやすさは着実に上がります。まずは一本、このテンプレートに沿って書いてみてください。