docutest

AI 코딩 에이전트를 위한 Docusaurus 문서화 프로젝트 초기 구동 지시서(Prompt) 관리 저장소입니다.

개요

이 프로젝트는 Docusaurus 기반의 프로젝트 문서 시스템을 빠르게 구축하기 위한 초기화 프롬프트와 문서 운영 규약을 관리합니다. AI 코딩 에이전트에게 이 지시서를 제공하면, 일관된 구조와 규칙을 갖춘 문서 저장소를 자동으로 생성할 수 있습니다.

핵심 파일

파일	설명
DOCS.md	프로젝트 문서 운영 규약. 디렉토리 구조, 파일명 규칙, 프런트매터, 사이드바 레이블, Draft/Approved 워크플로우 등 모든 문서 작성 규칙을 정의합니다.
DOCS_INIT_PROMPT.md	Docusaurus 문서 리포지토리 초기화 프롬프트. AI 에이전트에게 제공하면 DOCS.md 규칙에 맞는 Docusaurus 프로젝트를 처음부터 세팅합니다.

Quick Start

mkdir my-project-docs && cd my-project-docs
curl -fsSL https://raw.githubusercontent.com/daegil/docutest/main/init.sh | bash

이 명령어 한 줄이면 DOCS.md와 DOCS_INIT_PROMPT.md가 다운로드됩니다. 이후 AI 코딩 에이전트에서 초기화 프롬프트를 실행하면 끝!

Initialize the project based on @DOCS_INIT_PROMPT.md

특정 브랜치로 테스트

feature 브랜치의 변경사항을 테스트하려면 sed로 브랜치명을 치환합니다:

mkdir my-project-docs && cd my-project-docs
bash <(curl -fsSL "https://raw.githubusercontent.com/daegil/docutest/BRANCH_NAME/init.sh" | sed 's/BRANCH="main"/BRANCH="BRANCH_NAME"/')

BRANCH_NAME을 실제 브랜치명으로 교체하세요. 브랜치에 /가 포함된 경우 sed 구분자와 충돌하지 않도록 이스케이프합니다 (예: feature\/mermaid-rendering).

예시:

bash <(curl -fsSL "https://raw.githubusercontent.com/daegil/docutest/feature/mermaid-rendering/init.sh" | sed 's/BRANCH="main"/BRANCH="feature\/mermaid-rendering"/')

사용 방법

1. 새 문서 저장소 생성 (init.sh)

# 새 프로젝트 디렉토리 생성 후 init.sh 실행
mkdir my-project-docs && cd my-project-docs
curl -fsSL https://raw.githubusercontent.com/daegil/docutest/main/init.sh | bash

init.sh는 다음을 수행합니다:

• 현재 디렉토리가 비어있는지 확인 (경고만, 강제 중단 아님)
• GitHub에서 DOCS.md, DOCS_INIT_PROMPT.md 다운로드
• 다음 단계 안내 메시지 출력

다운로드 후 AI 코딩 에이전트에서 아래와 같이 입력하세요:

Initialize the project based on @DOCS_INIT_PROMPT.md

2. 초기화 후 생성되는 구조

docs/
├── 00-meta/          # 프로젝트 메타 정보 (개요, 규칙, 템플릿)
├── 10-plan/          # 계획 문서
│   ├── drafts/       # 초안 계획
│   └── approved/     # 승인된 계획
├── 20-execution/     # 실행 기록
│   ├── logs/         # 실행 로그
│   ├── decisions/    # 의사결정 기록 (ADR)
│   └── meetings/     # 회의록
├── 30-deliverables/  # 산출물 정의/정리
├── 40-retros/        # 회고
└── 90-reference/     # 참고자료/리서치/용어집

문서 운영 규약 요약

DOCS.md에 정의된 주요 규칙:

• 파일명: YYYY-MM-DD-NNN-kebab-title.md 형식
• 사이드바 레이블: [YYYY/MM/DD-NNN] 제목 형식으로 시간순 자동 정렬
• 프런트매터: title, sidebar_label, tags, draft 필수
• 워크플로우: drafts/ → approved/ (Draft → Approved)
• 문서 유형: 계획, 실행 로그, 의사결정(ADR), 회의록, 산출물, 회고

기술 스택

• Docusaurus - 정적 문서 사이트 생성기
• Markdown + YAML 프런트매터
• 자동 생성(autogenerated) 사이드바

라이선스

MIT