| name | tech-article-review |
| description | 技術記事の推敲と品質向上を支援するskill。記事を読み、構造・読みやすさ・技術的正確性・表現の明確さ・コードサンプルの品質をチェックし、改善提案を行う。ユーザーが「記事を推敲して」「記事をレビューして」「記事の品質をチェックして」などと依頼した際に使用する。 |
技術記事推敲スキル
このスキルは、技術記事の品質を向上させるための体系的な推敲を支援します。
使用タイミング
以下のような依頼があった際に、このスキルを使用してください:
- 「記事を推敲して」
- 「記事をレビューして」
- 「記事の品質をチェックして」
- 「読みやすさを改善して」
- 「技術記事をブラッシュアップして」
推敲の流れ
1. 記事の読み込みと全体把握
まず、記事ファイルを読み込み、以下を確認します:
- 記事のテーマと目的
- 想定読者層
- 記事の構成(導入・本文・まとめ)
- 全体の文章量とボリューム感
2. 体系的なチェック
以下の6つの観点で記事を評価し、具体的な改善提案を行います:
(1) 記事構造のチェック
- 導入部分: 読者の興味を引くか、記事の目的が明確か
- 本文構成: 論理的な流れになっているか、見出しの階層構造は適切か
- まとめ: 要点が整理されているか、次のアクションが示されているか
- 全体のバランス: セクション間の分量は適切か
(2) 読みやすさのチェック
- 文章の長さ: 1文が長すぎないか(目安:60文字以内)
- 段落構成: 1段落1トピックになっているか
- 改行と空白: 適切な余白があり、視覚的に読みやすいか
- 見出し: 内容を的確に表現しているか
- リスト: 箇条書きを効果的に使っているか
(3) 技術的正確性のチェック
- 用語の正確性: 技術用語は正しく使われているか
- コマンド・コード: 実行可能で、エラーがないか
- バージョン情報: 必要に応じてバージョンが明記されているか
- 前提条件: 必要な環境や前提知識が示されているか
(4) 表現の明確さ
- 曖昧な表現: 「〜など」「〜とか」の多用を避ける
- 主語の明確化: 何が・誰が・どうするのか明確か
- 専門用語の説明: 初出時に適切に説明されているか
- 代名詞の使用: 「これ」「それ」が指す対象は明確か
(5) コードサンプルの品質
- 可読性: インデント、コメント、変数名は適切か
- 完全性: そのまま動作する完全なコードか、一部の抜粋か明示されているか
- 説明: コードの前後で十分な説明があるか
- シンタックスハイライト: 言語指定がされているか
(6) ターゲット読者への適切さ
- 難易度: 想定読者のレベルに合っているか
- 前提知識: 読者が持つべき前提知識は示されているか
- 説明の詳しさ: 初心者向けなら丁寧に、上級者向けなら簡潔に
3. 推敲の4つの技法の適用
石原尚氏の推敲手法を技術記事に適用します:
「切り分ける」
- 長すぎる段落や文章を適切に分割
- 1つの見出しに複数のトピックが混在している場合、見出しを増やす
- 長いコードブロックを機能ごとに分割
「並び替える」
- 論理的な順序に再構成(例: 前提条件 → 基本 → 応用)
- 重要度の高い情報を前に配置
- 時系列や因果関係に沿った順序に
「繋ぎ方を変える」
- セクション間の接続を改善(接続詞、遷移文の追加)
- 見出しレベルの調整
- 箇条書きと本文の使い分け
「削り落とす」
- 冗長な表現を簡潔に
- テーマから外れた内容を削除
- 同じ内容の重複を削減
- 不要な修飾語を削除
出力フォーマット
推敲結果は以下の形式で提示します:
# 技術記事推敲レポート
## 総合評価
[記事の現状と全体的な印象]
## 主な改善ポイント
### 1. 記事構造
- [具体的な指摘と改善案]
### 2. 読みやすさ
- [具体的な指摘と改善案]
### 3. 技術的正確性
- [具体的な指摘と改善案]
### 4. 表現の明確さ
- [具体的な指摘と改善案]
### 5. コードサンプル
- [具体的な指摘と改善案]
### 6. ターゲット読者への適切さ
- [具体的な指摘と改善案]
## 推敲の4技法による具体的修正案
### 切り分けるべき箇所
[行番号と具体的な修正案]
### 並び替えるべき箇所
[セクション名と具体的な修正案]
### 繋ぎ方を変えるべき箇所
[行番号と具体的な修正案]
### 削り落とすべき箇所
[行番号と具体的な修正案]
## 優先的に対応すべき項目TOP3
1. [最も重要な改善点]
2. [次に重要な改善点]
3. [その次に重要な改善点]
## 良い点(維持すべきポイント)
- [記事の優れている点を具体的に]
実行手順
- 記事ファイルの読み込み:
Readツールで記事を読み込む - 全体分析: 記事の構成とテーマを把握
- 6つの観点でチェック: 各項目を順次評価
- 4つの技法を適用: 具体的な修正案を作成
- レポート作成: 上記フォーマットで推敲結果をまとめる
- ユーザーへの確認: 修正を適用するか、ユーザーに確認する
注意事項
- 元の意図を尊重: 著者の意図や文体を損なわない範囲で提案する
- 具体的な指摘: 「わかりにくい」ではなく「○○が不明確」と具体的に
- ポジティブな指摘: 良い点も積極的に伝える
- 優先順位: すべての指摘を適用する必要はなく、重要度を示す
- 実行可能性: 修正が容易な順に並べ、段階的改善を可能にする
ツールの使用
このスキルでは以下のツールを使用します:
Read: 記事ファイルの読み込みGrep: 特定パターンの検索(例: 長すぎる文の検出)EditまたはWrite: ユーザーが承認した修正の適用
記事の品質向上を通じて、読者により価値のある技術情報を届けることを目指します。