IT記事添削スキル
Purpose
QiitaとZennに掲載するIT関連記事の品質向上を支援するスキル。文法、表現、技術的な正確性、記事スタイルをチェックし、修正提案ではなく確認依頼を出します
このスキルは以下の場合に使用してください
- •QiitaまたはZennに掲載予定のIT関連記事の内容を添削したい
- •記事の可読性や説得力を改善したい
- •スタイルガイドへの準拠状況を確認したい
チェック対象
1. 技術的な正確性
- •記述されている技術用語、概念の正確性
- •コード例の構文的正確性(※バグがないと仮定)
- •APIの説明や仕様の正確性
- •バージョンや推奨事項の現在の妥当性
2. 文章・表現の品質
- •文の構成と論理性
- •説明の順序と段階性
- •読者層の想定と説明レベルの適切性
- •専門用語と一般的な説明のバランス
3. スタイルガイドへの準拠
- •文末の「。」(句点)を使用しないスタイル
- •敬体・常体の一貫性
- •見出しレベルの適切性
- •箇条書きの形式統一
4. 構成・可読性
- •記事全体の流れと構成
- •見出しの階層構造
- •段落分け
- •コード例の効果的な配置
5. メタデータ確認
- •タイトルの適切性と長さ
- •説明文(description)の有無と内容
- •タグの適切性と最大数の確認(Qiita:5個、Zenn:5個)
添削プロセス
- •記事内容の読み取り - 全体を把握
- •チェック項目の確認 - 上記5項目を対象に分析
- •修正箇所の特定 - 問題がある箇所を明確化
- •修正提案の準備 - 改善案を用意
- •確認依頼の出力 - 修正箇所を報告し承認を待つ
出力フォーマット
code
📝 [記事タイトル] の添削結果 🔍 チェック項目別の確認: 【技術的な正確性】 - [指摘内容(問題がない場合は「問題なし」)] 【文章・表現の品質】 - [指摘内容] 【スタイルガイド準拠】 - [指摘内容] 【構成・可読性】 - [指摘内容] 【メタデータ確認】 - [タイトル・タグなどの指摘] --- 🔧 修正が必要な箇所: [修正箇所1] 📌 確認依頼: - 修正前:[該当テキスト] - 修正案:[提案内容] - 理由:[修正理由] [修正箇所2] 📌 確認依頼: - 修正前:[該当テキスト] - 修正案:[提案内容] - 理由:[修正理由] (複数の修正箇所がある場合) --- ✅ 修正不要の箇所: - [特に良い点があれば記載] --- Skill Executed (article-review-skill) ---
重要な処理フロー
修正が必要な場合、以下のフローで対応してください:
- •修正箇所を明確に指摘
- •修正案を提示
- •「承認をお待ちしています」と確認依頼を出す
- •ユーザーの承認を待つ
- •承認後に初めて実際の修正を実行
修正前に承認を取ることで、ユーザーの意図と異なる修正を防ぎます
例外・注意点
- •コードの検証は不要 - コード例はバグが起きないものと考えます
- •技術内容の校正に注力 - 誤字よりも技術的な正確性を優先
- •スタイル統一 - 「。」がない文体での統一確認が重要
- •Qiita・Zenn特有の仕様 - 両プラットフォームの違いを考慮