Communityライティング&編集github.com

Al0olo/Agents-village

このリポジトリのスタイルに従ってドキュメント、README、PR説明、調査文章を作成・編集します。読者向けの文章を作成する際に使用します。

Agents-village とは?

このスキルは、リポジトリ内のドキュメントやREADME、プルリクエストの説明、調査文章を一貫したスタイルで作成・編集するためのものです。具体的なルールとして、要点を先に述べる、一文一意、短い文章、具体性の重視(数字・ファイル・コマンド・名前)、プロセス説明や自己参照の禁止、不要な修飾語の排除(「重要である」「堅牢」「包括的」など)、テーブルは比較のみに使用、リストは手順か並列項目のみ、不確実性は一度だけ述べ解決策を示す、各ディレクトリにはREADME.mdとAGENTS.mdを配置し更新する、読者向けドキュメントには署名と日付を最大1つ、運用状態はdocs/HANDOFF.mdとdocs/handoff/LOG.mdに記録する、読み手として読み直して飛ばされる部分を削除する、といったルールが含まれます。主にClaude CodeやCursor、CodexなどのAIエージェントがリポジトリ内で一貫した文体を維持するために使用されます。

対応~Claude Code~Codex CLI~Cursor
npx skills add https://github.com/Al0olo/Agents-village/tree/HEAD/.claude/skills/docs-style

Installed? Explore more ライティング&編集 skills: steipete/notion, langchain-ai/langchain, bytedance/podcast-generation · View all 6 →

お気に入りのAIに質問する

このエージェントスキルを事前に読み込んだ状態で新しいチャットを開きます。

ドキュメント

ドキュメントスタイル

  • 要点を先に述べる。一文につき一つのアイデア。短い文章。
  • 一般的な表現よりも具体的に:数字、ファイル、コマンド、名前。
  • 読者向けのドキュメントでは、プロセス説明や自己参照をしない。
  • 不要な語句は削除:「重要な点として」「〜するために」「堅牢」「活用」「包括的」「シームレス」。
  • テーブルは比較のためだけに使用。リストは手順か並列項目のみ。
  • 不確実性は該当する場所で一度だけ述べ、それを解決する方法を示す。
  • 各ディレクトリにはREADME.md(内容と、人向けの説明)とAGENTS.md(エージェントが行動するためのルール)を配置する。ディレクトリの目的やルールが変わったら両方を更新する。
  • 読者向けのドキュメントには、署名と最大1つの日付を記載する。運用状態はdocs/HANDOFF.mdとdocs/handoff/LOG.mdに記録する。
  • 他人の立場で読み直す。読み手が飛ばすであろう部分は削除する。

Individual skills in this repo

This repo contains 3 individual skills — each has its own dedicated page.

関連スキル