agentleFS
Kyungjong-kimKyungjong-kim/claude-code-harness/skills/document-review/SKILL.md

document-review

Skill0 starsChanged 5 months agoMITView on GitHub

제공된 문서 세트의 구조·연동·완전성을 시나리오 기반으로 검증하고 발견된 이슈를 우선순위에 따라 수정한다. 문서 간 교차 참조 일관성, 흐름 단절, 정보 누락 등을 탐지하는 품질 검증 도구. 트리거 키워드: "문서 평가", "document review", "문서 검토", "문서 품질 검증", "/document-review"

11 other projects use a version of this.

Adopted by

Most recently taken up by

Used with

Projects with it also use setup, skill-creator and 1 more.

Other files people use alongside this one.

Files found in the same public projects as a version of this one, more often than they turn up anywhere else. Each project counts once, large collections count for less, and this file's own repository is left out.
  • VercelSkill

    setup

    Set up Vercel CLI and project configuration. Use when the user says "set up Vercel", "configure Vercel", "link to Vercel", or "vercel init".

    Also in 3 projects that use this

  • SentrySkill

    skill-creator

    Create new agent skills following the Agent Skills specification. Use when asked to "create a skill", "add a new skill", "write a skill", "make a skill", "build a skill", or scaffold a new skill with SKILL.md. Guides through requirements, writing, registration, and verification.

    Also in 3 projects that use this

  • GoogleSkill

    code-review

    Adversarial systems, concurrency, memory-model, and architecture code review protocol. Use this skill whenever asked to review code, PRs, diffs, or branches in Filament.

    Also in 3 projects that use this

The file

Files
SKILL.md

Document Review

문서 세트를 시나리오로 추적해 갭·모호함·불일치를 찾아 수정한다. 특정 경로나 문서 종류에 의존하지 않는다. 사용자가 명시하거나 현재 세션에서 확인 가능한 문서를 대상으로 삼는다.

Step 1 — 평가 대상 문서 파악

트리거 시 아래 순서로 평가 대상을 결정한다.

  1. 사용자가 경로를 명시한 경우 → 해당 경로의 모든 .md 파일을 읽는다.
    find <지정_경로> -name "*.md" | sort
  2. 현재 세션에서 이미 논의된 문서가 있는 경우 → 그 문서들을 평가 대상으로 삼는다.
  3. 아무것도 없는 경우 → 사용자에게 경로를 요청한다.

    "평가할 하네스 문서의 경로를 알려주세요. (예: ~/Documents/Dev-Vault/code-harness)"

모든 문서를 읽은 후 목록을 출력하고 Step 2로 진행한다.


Step 2 — 시나리오 정의

사용자에게 아래 질문을 한다:

"어떤 상황을 시나리오로 검증할까요?

예시:

  • 새 개발자가 프로젝트에 처음 합류해 하네스를 구축하는 상황
  • 기존 개발자가 버그 이슈를 받아 수정 후 PR을 생성하는 상황
  • QA 피드백을 받아 브랜치에 추가 커밋하는 상황
  • 세션을 종료하고 다음 세션을 시작하는 상황

직접 설명해도 됩니다."

사용자 답변을 받으면 아래 세 항목을 정리해 확인한다:

항목내용
페르소나누가 이 문서를 읽는가 (새 개발자 / 기존 개발자 / 에이전트 등)
트리거어떤 요청·상황으로 시나리오가 시작되는가
기대 결과시나리오 끝에 무엇이 완료되어야 하는가

사용자가 확인하면 Step 3으로 진행한다.


Step 3 — 시나리오 추적

정의된 시나리오로 문서를 Phase별로 추적하며 검증한다.

각 Phase마다 세 가지 기준으로 평가한다:

기준질문
명확성에이전트가 다음 행동을 알 수 있는가?
완전성필요한 정보·명령이 모두 있는가?
일관성문서 간 교차 참조(Q번호, 경로, 링크)가 맞는가?

Step 4 — 이슈 분류

발견한 이슈를 아래 기준으로 분류한다.

등급기준처리
🔴 차단이 이슈가 있으면 시나리오 특정 Phase를 진행할 수 없음즉시 수정
🟡 혼동진행은 되지만 에이전트가 잘못된 결정을 내릴 수 있음즉시 수정
🟢 개선없어도 동작하지만 있으면 더 명확함사용자 판단 후 수정

이슈 목록을 먼저 출력하고 사용자에게 확인받은 뒤 Step 5로 진행한다.

이슈 출력 형식:

[평가 결과]
발견된 이슈: 🔴 N개 / 🟡 N개 / 🟢 N개

🔴 차단
1. [파일명] <이슈 설명> — <수정 방향>

🟡 혼동
1. [파일명] <이슈 설명> — <수정 방향>

🟢 개선 (선택)
1. [파일명] <이슈 설명>

Step 5 — 수정 실행

🔴 → 🟡 순서로 수정한다. 🟢는 사용자가 "🟢도 수정해줘"라고 하면 수정한다.

수정 시 규칙:

  • 한 파일씩 수정하고 다음 파일로 넘어간다 (병렬 수정 금지 — 충돌 방지)
  • 기존 문서 스타일(태그, 들여쓰기, 마크다운 형식)을 유지한다
  • 관련 교차 참조(Q번호, 링크, 인덱스)를 함께 수정한다

Step 6 — 결과 보고

[수정 완료]
수정된 파일: N개
- <파일명> — <수정 내용 한줄>
- ...

남은 🟢 이슈 (선택적 개선):
- <내용> (원하시면 말씀해주세요)

Download now (ZIP)

Does it work?

Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.

No reviews yet

People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.

  • It worked
  • Partly
  • It didn't
What did you use it for? e.g. Reviewing pull requests in a Rails app

Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.

Your trail

Files you open will collect here, so you can find them again.

Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.

Now do this for your own.

Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.