Format doc

Skill idylle-cynique/solo-dev-skills/skills/format-doc

Claude Code / GitHub Copilot 等向けエージェントスキル集（gh skill installで導入可能）

Install

npx -y skills add idylle-cynique/solo-dev-skills --skill format-doc

Assembled from the repository path, not quoted from the project. Check it against their README if it does not work.

2 things to look at

18 days oldThe repository was created 18 days ago. New is not bad, but a brand new repository carrying a familiar-sounding name is the shape a typosquat arrives in, and there has been no time for anyone else to find a problem with it.
0 stars0 stars. Stars are a popularity signal and not a quality one, but at this level it is likely that nobody has read this closely except its author, and you would be relying on your own review.

What its author says it does

Copied from the file, not written here

Markdownドキュメントのリスト構造を整形するスキル。1項目1事実・補完情報の階層化・リスト末尾の句読点除去・太字の整理を行う。「ドキュメントが乱雑」「リストを整理して」「見やすくして」「整形して」と言われたとき、またはリストに複数の事実が詰め込まれている・末尾に句読点がある・補足情報が同一行に混在しているのを見つけたときは、明示されていなくてもこのスキルを参照すること。

The file declares its own license as MIT. That is the author’s claim about this one file, and it is not the same thing as the license GitHub reports for the repository, which is listed with the other numbers below.

SKILL.md

4.1 KB, as published. Nobody here has run it

整形原則

後続の読者が「主要な事実」と「補足情報」を素早く区別できるようにすることが目的。以下の4原則を順に適用する。

原則1: 1項目1文・1文1事実

1つのリスト項目には1つの事実だけを記載する。複数の事実が1行に詰め込まれている場合は分割する。

# 分割前
- 月次シートはテンプレートから複製する運用で、集計シートはIMPORTRANGEで集約されており、URL変更で連携が壊れる。

# 分割後
- 月次シートはテンプレートから複製する運用
- 集計シートは月次シートを IMPORTRANGE で集約している
  - 月次シートの URL が変わると集計シートとの連携が壊れる

原則2: 補完情報は子項目に階層化

理由・制約・実装方法・例外・補足は、親項目に — で続けず、ネストした子項目として記載する。どの情報が主でどれが従かが一目でわかるように構造化する。

# 分割前
- 背景色はセル値でなく書式情報のため GAS（getBackgrounds()）または Sheets API の effectiveFormat で取得する（値だけ読む実装では判定不可）。

# 分割後
- 背景色はセル値ではなく書式情報として取得する必要がある
  - GAS: `getBackgrounds()` を使う
  - Sheets API: `effectiveFormat` で取得する
  - 値読み取りのみの実装では背景色の判定は不可

原則3: リスト項目末尾に句読点をつけない

リスト項目の末尾に 。 や 、 をつけない。文中で区切り記号として機能している 。 はそのまま残す。

# 除去対象（末尾の句点）
- 対象ファイル名は `file_x`（格納先「ドライブA」）。
→ - 対象ファイル名は `file_x`（格納先「ドライブA」）

# 残す例（文中の区切り句点）
- `webhook`: 対象。通知経路の一種

原則4: 他動詞を含まない項目は `語: 語` 記法で表現する

属性・値・場所・出典など、能動的な動作を含まない項目は 語: 語 または 語: 文 の対応関係で記述する。動詞を補って文にするより直感的に読める。

# 動詞補完（避ける）
- 格納先「ドライブA」にある
- 識別子 `xxxxxxx` は本アカウント

# 対応関係記法（推奨）
- 格納先: `ドライブA`
- 識別子: `xxxxxxx`

典型的な適用場面: 格納先・出典・値・識別子・バージョン・状態など。

原則5: 太字を過剰に使わない

**太字** は見出し相当の視覚表現か、読者に認知させるべき重大な事実のみに限定する。用語名・パス・固有名詞・一般的な強調に片端から太字を使わない。

作業手順

対象ファイルを Read で読み込む
リスト項目（- または * で始まる行）を洗い出し、上記4原則の違反箇所を特定する
本文の散文・テーブルセルはスコープ外として変更しない
整形後のファイルを Write で書き戻す（既存ファイルの上書き更新）
主な変更点を簡潔に報告する（変更の種類とセクション名）

スコープ外（変更しないもの）

本文段落（散文）: 通常の文として 。 で終わることは正しい
テーブルセル: 句読点ルールの対象外
コードブロック・インラインコード内: 内容を変更しない
セクション見出し（##）: 変更しない