메뉴
README、ADR、Runbook、API Docs、開発者向けドキュメント、コードコメントなど、技術文書を作成・更新するときに使う。変更理由、影響範囲、互換性、運用注意、戻し方を整理し、未来の開発者が最短で理解できる文書にする。
기본적으로 소스를 먼저 확인하는 Prompt가 선택됩니다. 직접 명령으로 전환하거나 로컬 사본을 다운로드할 수도 있습니다.
설치 여부를 결정하기 전에 SKILL.md와 SkillsMP에 표시된 보조 파일을 읽어 보세요.
Codex 또는 Claude로 설치 이 Prompt를 복사해 Codex, Claude 또는 다른 어시스턴트에 붙여 넣으면 Skill 페이지를 검토하고 설치를 진행할 수 있습니다.
직접 명령은 검토 Prompt를 거치지 않습니다. 실행하기 전에 소스를 확인하세요.
npx skills add https://github.com/version-1/agents-docs --skill documenting명령은 한 줄로 유지됩니다. 복사하기 전에 가로로 스크롤해 전체 내용을 확인하세요.
로컬 사본을 원하시나요? SkillsMP에서 현재 제공할 수 있는 파일을 다운로드하세요.
Git リポジトリで新しい作業を始める前に、最新のデフォルトブランチへ追従し、タスク内容に合う作業ブランチを作成して、不要なローカルブランチ整理を非同期に依頼するときに使う。ユーザーが「ブランチ切って」「作業を始める準備して」「新しいタスク用ブランチを作って」「最新 main から始めたい」などを依頼した場合はこの skill を使い、ブランチ名を報告してからタスク詳細の入力を待つ。
Issue Finder agent がコードベースを変更せず、指定された finder 分野の課題を根拠付きで調査し、優先順位付けした Markdown を指定ディレクトリへ出力するときの共通手順、安全制約、品質基準、出力 contract を定義する。
コード、設定、依存関係、権限境界にある悪用可能な脆弱性を安全に調査し、コードを変更せず課題レポートへ整理するため issue-finder agent に委譲するときに使う。一般的なコードレビュー、侵入や攻撃の実行、脆弱性修正には使わない。
SOC 직업 분류 기준
SKILL.md 표시 중
| name | documenting |
| description | README、ADR、Runbook、API Docs、開発者向けドキュメント、コードコメントなど、技術文書を作成・更新するときに使う。変更理由、影響範囲、互換性、運用注意、戻し方を整理し、未来の開発者が最短で理解できる文書にする。 |
目的：未来の自分（または他者）が「なぜ・何が・どう使う」を最短で理解できるようにする
ドキュメントを作成・更新するときは、次の順序で進める。
README はサブディレクトリにも置く
AGENTS.md は常時読まれる前提で、長くなりすぎないようにする。詳細、例、例外、長いチェックリストは docs、skill、references に逃がす。
入口になる文書には、判断に必要な最小情報だけを書く。読み手が必要な深さまで段階的に掘れるように、詳細は参照先へ分ける。
# ADR-XXXX: <短い結論>
## Context
- 背景・問題・制約
## Decision
- 何を選ぶか（結論）
## Alternatives
- 検討した案（簡潔に）
## Consequences
- 良い点 / 悪い点 / 将来の影響
## Notes
- 移行、ロールバック、関連リンク
Markdown は「正しく表示されること」よりも
レンダリング後に読みやすいことを重視して記述してください。
これは1つ目の段落。
これは2つ目の段落。
これは3つ目の段落。
これは段落。