gh-setup · 스킬 설명서

docs-bootstrap

빈 repo 에 kind-split docs/ 디렉터리 트리를 만든다. 8개 리프 폴더와 각각의 .gitkeep, 그리고 정책 문서 docs/README.md 가 산출물이다.

스캐폴드 전용 기본 모드 --dry-run 네트워크 불필요 gh CLI 불필요 반복 실행 안전
01

무엇을 만들어 내는가

정책은 폴더 = 문서 종류, 기능 = 파일 이름이다. 폴더는 비어 있고, git 이 빈 폴더를 추적하도록 리프마다 .gitkeep 이 들어간다.

8 리프 폴더 adr · product · design · architecture/system · architecture/features · testing · guides · public
8 .gitkeep 리프마다 하나. 빈 폴더를 git 이 추적하게 한다.
1 정책 문서 docs/README.md — 스킬이 본문을 쓰는 유일한 파일.
0 네트워크 호출 셸과 쓰기 가능한 디렉터리만 있으면 된다.
산출 트리

리프 8 + 문서 1

adr/.gitkeep
product/.gitkeep
design/.gitkeep
testing/.gitkeep
guides/.gitkeep
public/.gitkeep
architecture/system/.gitkeep
architecture/features/.gitkeep
README.md정책 문서
폴더문서 종류를 나타낸다.
파일 이름개별 기능을 나타낸다.
.gitkeep실제 문서가 들어오면 지워도 된다.
02

언제 쓰고 언제 안 쓰는가

이 스킬이 맡는 범위는 하나다 — 빈 골격 세우기. 나머지는 다른 도구의 몫이다.

새 repo 에 문서 골격을 깐다
이 스킬 — 예
이미 문서가 들어 있는 docs/ 를 재배치한다
대신 수동 마이그레이션 (이 스킬은 스캐폴드 전용)
PRD / TRD / ADR 본문을 쓴다
대신 별도 문서 작성 스킬
라벨이나 보드가 필요하다
대신 label-bootstrap, kanban-bootstrap

네 스킬 중 유일하게 네트워크도 gh 도 필요 없다

셸과 쓰기 가능한 디렉터리만 있으면 된다.

03

호출 형식

스킬로 부르거나, 같은 인자를 그대로 셸 스크립트에 넘긴다.

스킬 호출
/gh-setup:docs-bootstrap [path] [--check|--apply|--dry-run] [--force]
셸에서 직접
bash skills/docs-bootstrap/lib/scaffold.sh [path] [--check|--apply|--dry-run] [--force]
path
대상 repo 루트. 기본은 현재 디렉터리. 그 아래에 docs/ 를 만든다.
--dry-run
기본값. 생성 계획만 출력하고 아무것도 쓰지 않는다. 항상 0 으로 종료.
--check
읽기 전용 감사. 완비면 0, 하나라도 빠지면 0 이 아닌 값으로 종료 — CI 게이트용.
--apply
디렉터리, .gitkeep, docs/README.md 를 실제로 만든다.
--force
--apply 와 함께 쓸 때만 유효. 기존 docs/README.md 를 덮어쓴다.
-h, --help
도움말 출력 후 종료. 파일 시스템에 접근하지 않는다.
--help --check --apply --dry-run 모드 우선순위 — 여러 개가 함께 오면 왼쪽이 이긴다.

모드를 골라 명령을 만들어 보기

bash skills/docs-bootstrap/lib/scaffold.sh . --dry-run

04

동작 단계

세 단계로 끝난다. 판정과 계획은 스크립트가 내고, 스킬은 그대로 전달한다.

인자 파싱

인자를 파싱해 대상 경로와 모드를 정한다.

lib/scaffold.sh 실행

레이아웃 SSOT 는 이 스크립트, README 본문 SSOT 는 references/docs-readme-template.md 다.

결과 전달

스크립트의 [OK] / [FAIL] 판정과 create/skip 계획을 그대로 전달하고, 다음 단계 힌트로 마무리한다.

05

주의사항 / 제약

쓰기는 언제나 명시적이어야 하고, 기존 내용은 건드리지 않는다.

기본이 --dry-run 이다

--apply 를 명시해야만 파일이 생긴다.

docs/README.md 를 --force 없이 덮어쓰지 않는다

기존 README 는 보존된다.

문서 본문을 쓰지 않는다

docs/README.md 하나가 예외이고, 나머지 폴더는 비어 있는 상태로 남는다.

이미 채워진 docs/ 를 이전하지 않는다

기존 경로는 skip 줄로 넘어간다. 즉 여러 번 실행해도 안전하다.

.gitkeep 은 지워도 된다

빈 폴더를 유지하는 .gitkeep 은 실제 문서가 들어오면 지워도 된다.