문서 부트스트랩
이 작업은 가끔 수행하는 일괄 작업입니다. 이후 변경 사항에 대해서는 engineering:documentation-sync를 사용하세요.
1. 인벤토리 수집
존재하는 문서를 나열하고 각각을 있음, 얇음(존재하지만 대부분 비어 있거나 오래됨) 또는 없음으로 표시합니다. 최소한 다음을 확인하세요:
README.md, CONTRIBUTING.md, CHANGELOG.md, ARCHITECTURE.md 또는 docs/architecture/, 결정 레코드, CLAUDE.md, SECURITY.md, LICENSE, API 참조, 설정 참조, 런북.
git ls-files '*.md' | grep -v node_modules
2. 사용자가 선택하도록 함
resources/doc-catalog.md의 메뉴를 보여줍니다. 각 유형을 있음, 얇음 또는 없음으로 표시합니다. 이 프로젝트 유형에 추천하는 유형을 표시하세요.
- 있는 문서는 다시 작성하지 않습니다. 얇은 문서는 사용자가 "수정"을 선택할 수 있습니다.
- 사용자가 선택합니다. 사용자가 선택하지 않은 유형은 작성하지 마세요.
3. 사실 시트 작성
작성 전에 여러 문서에서 사용할 사실을 코드와 git에서 수집하세요. 기억에 의존하지 말고 수집하세요. 스크래치 파일에 기록합니다.
| 사실 | 출처 |
|---|---|
| 프로젝트 이름 및 한 문장 목적 | README, manifest, 사용자 |
| 현재 버전 | manifest, 최신 태그 (git describe --tags --abbrev=0) |
| 언어, 프레임워크 및 버전 | manifest 및 lock 파일 |
| 설치, 테스트, 린트, 빌드, 실행 명령어 | engineering:development-commands |
| 구성 요소 및 이름 | 디렉토리 구조, 진입점, compose 파일 |
| 환경 변수 및 설정 | .env.example, 설정을 읽는 코드 (process.env, os.environ, getenv 검색) |
| 중요한 날짜 | 첫 커밋 (git log --reverse), 태그 |
| 현재 작동하는 것, 작동하지 않는 것 | 사용자, 열린 이슈 |
두 출처가 일치하지 않으면 사용자에게 물어보세요. 조용히 하나를 선택하지 마세요. 모든 작성자는 사실 시트와 코드만 사용합니다.
4. 작성
- 세 개 이하의 문서: 직접 순서대로 작성합니다.
- 세 개 초과: 각 문서 또는 소그룹에 대해 하나의 하위 에이전트를 시작하고, 한 번에 최대 4개까지 진행합니다. 각 하위 에이전트에 다음을 제공합니다:
- 담당하는 정확한 파일(들)과 다른 파일은 변경할 수 없다는 규칙;
- 사실 시트;
resources/doc-catalog.md의 해당 유형별 섹션 개요;- Simplified Technical English로 작성하라는 지시(
simple-english스킬이 설치된 경우); - 필요한 사실을 찾지 못한 경우, 사실을 지어내지 말고 보고하라는 지시.
역사, 숫자, 사용자 또는 기능을 지어내지 마세요. "TBD"로 작성하고 사용자에게 나열하세요.
5. 세트 확인
resources/consistency-check.md를 따르세요. 계속하기 전에 모든 문제를 수정하세요.
6. 커밋
문서를 브랜치(engineering:git-branching)에 올리고 PR(engineering:github-pr-merge)을 여세요. PR 본문에 각 새 문서와 사용자의 답변이 필요한 모든 "TBD"를 나열하세요.
관련 스킬
engineering:documentation-sync: 이후 이 문서들을 올바르게 유지합니다.gener8v:brownfield: 기존 코드베이스를 gener8v 파이프라인에 온보딩합니다. 이 프로젝트 문서가 아닌.gener8v/컨텍스트를 작성합니다.