$docdiet
이 스킬은 사용자가 명시적으로 문서 검토, 정리 또는 업데이트를 요청할 때만 사용하십시오(일반적으로 $docdiet 호출). 이는 독립형 온디맨드 검토/업데이트 스킬이며, 자동 태스크별 훅이 아닙니다. 사용자가 지정한 문서 범위 또는 요청된 변경 사항에 명확히 드러난 범위만 검토 또는 업데이트하고, 관련 없는 감사를 시작하지 마십시오.
$docdiet all docs 또는 $docdiet project-wide와 같은 명시적 요청은 바운디드된 프로젝트 전체 패스를 허가합니다. 해당 모드에서 범위는 리포지토리 루트 아래의 .md, .mdx, .rst 또는 .adoc 확장자를 가진 문서 파일과 루트 레벨의 README* 및 CONTRIBUTING* 파일로 제한됩니다. 생성되거나 벤더된 디렉토리 및 파일, 변경 로그/릴리스 노트, 라이선스 또는 법적 자료, 행동 강령, 리포지토리 보호 파일은 제외하십시오. 발견은 해당 확장자와 제외 사항을 사용하는 한 번의 rg --files 목록으로 제한되며, 200개 경로로 제한됩니다. 해당 목록에서 반환된 경로만 검사하십시오. 변경된 공개 개념에 대해 정확하고 경로 제한된 추가 rg -l -F 참조 검색을 최대 한 번만 사용하십시오. 제한 또는 검색 경계에 도달하면 범위를 확장하지 않고 검토되지 않은 나머지를 보고하십시오.
결정 규칙
- 먼저 범위를 제한하십시오. 문서 파일이나 섹션이 지정되지 않았고, 문서가 수정되지 않았으며, 공개 개념의 이름 변경/제거로 인한 참조 확인이 필요하지 않으면 중단하십시오. 문서를 검사할지 여부를 결정하기 위해 문서를 검사하지 마십시오.
- 정식 소스를 편집하십시오. 개발자, 사용자, 운영자 또는 유지 관리자에게 필요한 내구성 있는 정보(계약, 설정, 구성, 운영, 제약 조건, 불변 사항, 비자명한 동작, 마이그레이션, 중요 경고)만 문서화하십시오. 구현 세부 사항, 임시 상태, 디버깅 기록, 추론된 사실, 완료 요약은 생략하십시오.
- 교체, 누적하지 마십시오. 기존 설명을 업데이트하고, 오래된 텍스트를 제거하며, 다른 문서에 포인터가 필요할 때 하나의 정식 소스로 링크하십시오. 마이그레이션, 호환성 또는 아키텍처 근거에 대해서만 과거 세부 정보를 유지하십시오.
- 정리를 로컬로 유지하십시오. 문서 파일을 편집하는 동안 수정된 섹션과 인접 텍스트 중 명백히 오래되었거나, 중복되었거나, 모순되거나, 대체되었거나, 오해를 불러일으키거나, 불필요하게 장황하거나, 변경/제거된 개념과 관련된 부분만 정리하십시오. 증거를 얻기 위해 상당한 조사가 필요하면 그대로 두십시오.
- 참조 검색을 제한하십시오. 이름이 변경, 제거 또는 변경된 공개 개념에 대해 정확하고 경로 제한된 검색을 최대 한 번만 허용합니다. 문서 글롭과 함께
rg -l -F를 선호하고 전체 일치 줄 대신 파일 이름만 보고하십시오. 위의 명시적 프로젝트 전체 모드 외에는 관련 없는 문서를 인벤토리화하거나, 문서 트리를 탐색하거나, 리포지토리 전체 링크를 확인하거나, 관련 없는 기록을 조사하거나, 정리 에이전트를 생성하지 마십시오. - 파일을 거의 생성하지 마십시오. 태스크에서 이미 알려진 적절한 정식 홈이 없는 내구성 있고 뚜렷한 정보에 대해서만 문서 파일을 추가하십시오.
보호
생성된 문서, 변경 로그/릴리스 노트, 라이선스 또는 법적 자료, 행동 강령, 벤더된/타사 문서 또는 리포지토리 보호 파일을 기회주의적으로 다시 작성하지 마십시오. 리포지토리 지침을 존중하고 의미 있는 프론트매터와 메타데이터를 보존하십시오.
Markdown 파일에 다음이 포함된 경우:
---
disable-agentic-editing: true
---
사용자가 해당 파일을 명시적으로 요청하지 않는 한 수정하지 마십시오. 이 마커는 docdiet 규칙입니다. 어떤 도구도 이를 강제하지 않으며, 리포지토리 지침이 그 보호를 제거할 수 없고, 해당 파일에 대한 명시적 요청만이 이를 무시합니다. 후보 파일에 대해서만 보호를 확인하십시오. 마커를 찾기 위해 리포지토리를 스캔하지 마십시오.
완료
문서가 수정된 경우, 수정된 파일/섹션만 정적으로 확인하십시오. 최종 동작이 필요한 곳에 문서화되었고, 오래된 텍스트가 증거와 함께 제거되었으며, 예제와 명령이 여전히 구현과 일치하고, 보호된 콘텐츠가 변경되지 않았는지 확인하십시오. 프로젝트 전체 모드에서는 수정된 각 파일에 이러한 확인을 적용하십시오. 리포지토리 전체 링크 또는 예제 검사로 검증을 확대하지 마십시오. 구현 태스크가 이미 요구하지 않는 한 예제나 명령을 실행하지 마십시오. 그런 다음 중단하십시오.
지속되는 것을 문서화하십시오. 누적하지 말고 교체하십시오. 태스크가 드러내는 것을 정리하십시오. 사냥하지 마십시오.