Community라이팅 & 에디팅github.com

SmallNoc/noc-living-docs

AI 지원 코드 변경, 요구사항, 상태, 가드레일, 테스트, 변경 기록을 동기화하는 리빙 문서 프로토콜 및 Codex 스킬입니다.

noc-living-docs란 무엇인가요?

이 스킬은 AI 에이전트(특히 Codex)가 프로젝트를 실행 가능한 메모리로 사용하도록 지원하는 '리빙 문서' 프로토콜입니다. `noc_docs/` 디렉토리를 중심으로 요구사항, 상태, 가드레일, 테스트 기록, 변경 기록을 코드 변경과 함께 지속적으로 동기화하여 프로젝트 지식이 항상 최신 상태를 유지하도록 합니다. 주요 기능으로는 `scripts/noc.py` CLI 도구를 통한 작업 계획 수립, 문서 색인, 변경 전 검사 등이 있으며, 가드레일 충돌이나 요구사항 불일치 시 자동으로 중단하고 사용자에게 확인을 요청합니다. 이 스킬은 새로운 기능 추가, 버그 수정, 리팩터링, API/보안/배포 변경 등 코드 변경이 수반되는 모든 작업에 적용 가능하며, 변경 영향 범위를 기능 맵을 통해 식별하고 필요한 문서만 읽어 효율적으로 작업합니다.

지원 대상~Claude Code✓Codex CLI~Cursor
npx skills add SmallNoc/noc-living-docs

Installed? Explore more 라이팅 & 에디팅 skills: steipete/notion, langchain-ai/langchain, bytedance/podcast-generation · View all 6 →

즐겨 사용하는 AI에게 물어보기

이 에이전트 스킬이 미리 로드된 새 채팅을 엽니다.

문서

프로젝트 리빙 문서

NOC 리빙 문서를 실행 가능한 프로젝트 메모리로 사용하세요. noc_docs/를 통해 경로를 지정하고, 영향을 받는 문서만 읽은 후, 코드나 의도가 변경되면 리빙 문서를 업데이트하고 CLI로 검증하세요.

트리거

이 스킬은 다음 경우에 사용하세요:

  • noc_docs/ 초기화 또는 마이그레이션
  • 요구사항 논의 후 코드 변경
  • 새로운 기능, 버그 수정, 리팩터링, API/데이터/보안/배포 변경
  • 코드 변경이 문서 업데이트를 필요로 하는지 확인
  • 프로젝트 리빙 문서 조회 또는 감사

프로젝트 메모리, 코드 동작, 요구사항, 가드레일, 테스트 또는 NOC 문서와 관련되지 않은 일반 질문에는 사용하지 마세요.

실행

  1. 요청, 변경된 경로, noc_docs/.living-docs/feature-map.json에서 영향을 받는 기능/도메인을 식별합니다.
  2. 코드가 변경될 수 있을 때 작업 계획을 실행합니다:
python scripts/noc.py work /path/to/project --feature <feature> --intent "<합의된 요구사항>"

기능 이름보다 경로가 더 명확한 경우 --path <code/path>를 사용하세요.

  1. 가장 작은 관련 문서(agent-guide.md, requirements.md, status.md, guardrails.md, test-record.md 및 도메인 가드레일(있는 경우))를 읽습니다.
  2. 확인된 새/변경된 의도를 requirements.md에 기록하고, 불확실한 논의는 notes.md에 기록합니다.
  3. 코드를 변경합니다.
  4. 동작, 검증, 중요 변경 사항 또는 제약 조건이 변경된 경우 status.md, test-record.md, change-record.md, guardrails.md를 업데이트합니다.
  5. 문서, 기능 또는 매핑 변경 후 python scripts/noc.py index <project>를 실행합니다.
  6. Git을 사용할 수 있는 경우 커밋 전에 python scripts/noc.py check <project> --staged --warn-only를 실행합니다.

자세한 워크플로 규칙은 references/workflow.md를 읽으세요.

진행하지 않음

다음 경우에는 코드 편집을 중단하고 사용자에게 물어보세요:

  • 요청이 guardrails.md 또는 도메인 가드레일과 충돌하는 경우
  • 제품 의도가 requirements.md와 충돌하고 의도된 방향이 명확하지 않은 경우
  • 영향을 받는 기능/도메인을 식별할 수 없고 변경이 명백히 전역적이지 않은 경우
  • 필수 문서가 누락되었고 작업이 알려지지 않은 요구사항이나 제약 조건에 의존하는 경우
  • 사용자가 요구사항을 현재 코드와 일치하도록 자동으로 재작성해 달라고 요청하는 경우
  • 변경이 보안, 권한, 결제, 데이터 손실, 마이그레이션 또는 공개 API 계약에 영향을 미치고 요청된 동작이 모호한 경우

완료 정의

이 스킬을 사용한 작업은 다음 조건이 모두 충족될 때만 완료됩니다:

  • 영향을 받는 문서가 기능 맵, 경로 또는 명시적 기능 이름을 통해 식별되었음
  • 필요한 문서를 읽었거나 누락된 문서가 지적되었음
  • 코드 변경과 문서 변경이 일치함
  • requirements.md는 의도된 동작 변경에 대해서만 변경되었음
  • status.md가 코드 변경 후 현재 동작을 반영함
  • test-record.md가 검증을 기록했거나 검증을 실행하지 않은 이유를 설명함
  • change-record.md가 중요한 구현 변경 사항을 기록함
  • 색인/검사가 가능한 경우 실행되었거나, 이유와 함께 건너뛰었음

최종 응답 형식

다음 형식으로 마칩니다:

NOC 리빙 문서:
- 확인한 문서:
- 업데이트한 문서:
- 의도적으로 변경하지 않은 문서:
- 실행한 명령어:
- 실행한 테스트:
- 남은 위험:

목록을 짧게 유지하세요. 해당되지 않는 범주는 없음을 사용하세요.

참고 자료

  • references/workflow.md: 모드 선택, 폴백 규칙, 충돌 처리, 작업 루프
  • references/feature-doc-template.md: 각 기능 문서가 포함해야 할 내용
  • references/domain-mode-guide.md: 도메인 모드 사용 시기 및 방법
  • references/codex-prompts.md: Codex 계획/목표/코드 워크플로를 위한 권장 사용자 프롬프트

관련 스킬