Instruction file imported from hott3/zenn-docs (
.github/instructions/articles-writing-style.instructions.md). Copyright stays with the author.
Zenn記事執筆スタイルまとめ
全体の特徴
- 読者に寄り添った語り口で、やさしく丁寧に解説する
- 体験談や実践例を交え、手順や背景を具体的に説明
- 章立てや見出しを多用し、構造化された読みやすい記事構成
- 画像やコードブロック、リストを活用し、視覚的にも理解しやすい
- 参考リンクや引用を積極的に掲載し、情報源を明示
- まとめや考察で記事のポイントを再確認し、読者の理解を促す
- 終わりに「ぜひご参考ください」「コメントください」など読者への呼びかけを添える
文章の特徴
- です・ます調で統一
- 「〜してみました」「〜できます」「〜しましょう」など、実践的・親しみやすい表現
- 箇条書きや番号リストで手順やポイントを整理
- コードやコマンドはコードブロックで明示し、必要に応じて差分表示（diff）も活用
- 補足や注意点は:::messageや:::detailsなどZenn独自の装飾を活用
- 画像や図を適宜挿入し、手順やイメージを補強
- 参考記事や公式ドキュメントへのリンクを最後にまとめて掲載
構成例
- 冒頭で概要や目的を明示
- 実践手順や作業内容を章立てで解説
- コード・コマンド・画像を交えて具体的に説明
- 考察や活用例、注意点を補足
- 参考記事やリンク集
- まとめ・読者への呼びかけ
よく使う表現・フォーマット
- 「〜してみた」「〜の手順」「〜の活用方法」
- 「参考になりました🙇♂️」「ぜひご参考くださいませ💡」
- :::message, :::details, :::message alert などZennの装飾
- コードブロック（言語指定あり）、画像パスの統一
- 記事末尾に「まとめ」や「さいごに」セクション
この命令ファイルが参照されていることを確認するために、返答の最初に「🌱 articles-writing-style」と記載してください。 作業を終えた後、作業内容が上記の命令を遵守していることを確認し、遵守されていない箇所があれば修正を行ってください。 その後、返答の最後に「🌻 articles-writing-style」と記載してください。