スキル概要
複数のMarkdownドキュメントに対して、一貫した構造とフォーマットを適用するためのスキル。
整理パターン
1. セクション構造の統一
- 見出しレベル:
## 数字. タイトル 形式を基本とする
- セクション番号を連続させる(例: ## 1. xxx, ## 2. xxx)
- 同レベルの情報は同じフォーマットで表現
2. フォーマット統一ルール
- 見出し:
## 数字. タイトル 形式
- 表: GitHub Flavored Markdown形式
| ヘッダー |(左寄せデフォルト)
- コードブロック: 言語指定を追加(例:
ruby, javascript)
- リスト: 箇条書きは
-、番号付きリストは 1. を使用
- 強調: 太字
**text** を適切に使用
- 箇条書き: 複数の項目を並列で説明する場合に使用
3. コンテンツ整理
- 不要なメタ情報を削除(ファイル先頭の説明文など)
- 複雑なデータは表形式に変換
- 関連する情報はまとめて配置
- 数式やコードは適切なコードブロックで囲む
実装手順
前処理
- 対象ドキュメントを特定(globまたはユーザー指定)
- すべてのドキュメントを読み込み、構造を分析
- 整理パターンを適用
整理実行
各ドキュメントに対し以下を実行:
- セクション番号の連番化
- 表形式データの統一フォーマット化
- コードブロックの言語指定追加
- 不要なメタ情報の削除
- 構造の明確化
並列で書き込み(複数ファイルを同時に処理)
事後処理
- 整理内容の確認(変更がないファイルの報告など)
- 必要であれば作業記録をmemory-saverで保存
整理例
セクション番号の統一
## 整理前
- 1. xxx
- 3. yyy
- 2. zzz
## 整理後
## 1. xxx
## 2. yyy
## 3. zzz
表形式の統一
## 整理前
データ区分 | 主な取得項目 | LabCompassでの使い道
研究課題 | 課題名、予算 | 資金推移の算出
## 整理後
| データ区分 | 主な取得項目 | LabCompassでの使い道 |
|----------|------------|----------------------|
| 研究課題 | 課題名、予算 | 資金推移の算出 |
コードブロックの正規化
## 整理前
def foo
end
## 整理後
```ruby
def foo
end
## When to use me
- 「ドキュメントを整理して」と言われた時
- 複数のMarkdownファイルのフォーマットが不統一な時
- ドキュメントの可読性を向上させたい時
- プロジェクトのドキュメント標準を適用したい時