gener8v/gener8v.claude-skills.engineering - 문서 동기화

문서 동기화

코드와 그 문서는 같은 커밋에서 함께 변경되어야 합니다. 잘못된 문서는 문서가 없는 것보다 더 나쁩니다.

문서가 잘못되는 세 가지 방식

• 오래됨. 문서가 여전히 이전 동작, 이름 또는 명령을 설명하고 있습니다.
• 누락됨. 새로운 동작, 새로운 명령 또는 새로운 설정에 대한 문서가 없습니다.
• 중복됨. 동일한 사실이 두 곳에 있습니다. 나중에 한 곳만 변경되고 다른 곳은 그대로 남습니다.

단계

1. 변경 사항 확인.

   git diff --cached --stat
   git diff --stat
   

2. 저장소 자체 규칙 찾기. CLAUDE.md, CONTRIBUTING.md 및 docs/README.md를 읽으세요. 어떤 주제를 어떤 문서가 담당하는지 명시되어 있다면 따르세요. 이 규칙들이 3단계보다 우선합니다.
3. 각 변경 사항을 담당 문서로 연결. resources/doc-routing.md를 사용하세요. 하나의 사실은 하나의 문서에만 있어야 합니다. 다른 문서는 그 문서로 링크합니다.
4. 오래된 참조 찾기. 이름을 바꾸거나 제거한 각 항목(함수, 플래그, 엔드포인트, 설정, 파일 경로, 명령)에 대해:

   git grep -n '<이전 이름>'
   

   문서에서 찾은 각 항목을 수정하세요. grep을 다시 실행하세요. 사후 조건은: 결과 없음, 또는 반드시 남아 있어야 하는 결과만 남음 (예: 이름 변경에 대한 CHANGELOG 항목).
5. 편집. 코드 변경으로 인해 잘못되거나 불완전해진 부분만 변경하세요. 관련 없는 섹션을 다시 작성하지 마세요. 명확한 문장을 위해 simple-english 스킬이 설치되어 있다면 사용하세요.
6. 함께 커밋. 문서 변경 사항을 코드와 함께 스테이징하세요. 나중에 별도 PR로 넣지 마세요.
7. 보고. 변경한 문서 목록을 알려주세요. 변경이 필요하지 않은 문서가 있다면 한 줄로 이유와 함께 말하세요. 예: "문서 불필요: 내부 리팩터링, 동작, 명령 또는 설정에 변경 없음."

담당 문서가 명확하지 않을 때

사용자에게 물어보세요. 질문을 피하기 위해 새 문서를 만들지 마세요.

유용한 테스트: 현재 상태에 대한 사실(설정, 버전, 상태)입니까? 그렇다면 참조 또는 상태 문서에 넣으세요. 절차(누군가 따라야 할 단계)입니까? 그렇다면 해당 절차를 담당하는 가이드, 런북 또는 스킬에 넣으세요.

사양이 먼저입니다

저장소에 SPEC.md(engineering:spec-writing 참조) 또는 .gener8v/specifications/ 아래 gener8v 사양이 있다면, 이는 의도된 동작을 정의합니다.

• 변경 사항이 사양대로라면, 사양을 편집할 필요가 없습니다.
• 변경 사항이 사양과 모순된다면, 멈추세요. 사용자에게 알리세요. 먼저 사양을 소유자를 통해 변경하세요: SPEC.md는 engineering:spec-writing에, 파이프라인 사양은 gener8v:specification에 문의하세요. 코드에 맞추어 사양을 조용히 편집하지 마세요.

파이프라인 문서

.gener8v/ 아래 파일을 수동으로 편집하지 마세요. gener8v 파이프라인 스킬이 이를 작성하고 업데이트합니다.

관련 스킬

• engineering:documentation-bootstrap: 문단 하나가 아닌 전체 문서가 누락된 경우.
• engineering:github-pr-merge: PR 전에 이 검사를 실행합니다.
• engineering:github-release: 이 스킬이 최신 상태로 유지하는 CHANGELOG Unreleased 섹션을 읽습니다.