Files
tpl-superclaude/.claude/commands/planning/create-doc.md
Paul.Kim c9020eb796 docs: 초기 파일 추가 및 기본 설정 구성
- .git-commit-template.txt: 커밋 메시지 템플릿 추가
- .gitignore: OS 및 데이터베이스 관련 파일 무시 설정 추가
- .mcp.json: MCP 서버 설정 추가
- CLAUDE.md: SuperClaude 엔트리 포인트 문서 추가
- README.md: 프로젝트 템플릿 설명 추가
- .claude/COMMANDS.md: 명령어 실행 프레임워크 문서 추가
- .claude/FLAGS.md: 플래그 시스템 문서 추가
- .claude/MCP.md: MCP 서버 통합 문서 추가
- .claude/MODES.md: 운영 모드 문서 추가
- .claude/ORCHESTRATOR.md: 지능형 라우팅 시스템 문서 추가
- .claude/PERSONAS.md: 페르소나 시스템 문서 추가
- .claude/PRINCIPLES.md: 핵심 원칙 문서 추가
- .claude/RULES.md: 실행 가능한 규칙 문서 추가
- .claude/settings.json: 권한 설정 추가
- .claude/commands 디렉토리: 다양한 명령어 문서 추가
- .taskmaster/config.json: 기본 설정 파일 추가
- .taskmaster/docs 디렉토리: 문서 파일 추가
- .taskmaster/tasks/tasks.json: 기본 작업 파일 추가
2025-07-20 22:25:33 +09:00

2.7 KiB

Feature Documentation Generator

When asked to enter "Documentation Mode" for a specific feature, I will:

  1. Analyze the feature scope: First, I'll ask 3-5 clarifying questions to understand exactly what feature needs to be documented and its boundaries.

  2. Review existing documentation: Before generating new documentation, I'll check and reference these existing guides:

    • Authentication patterns → @.cursor/rules/2106-auth.mdc
    • CRUD implementation → @.cursor/rules/2105-crud.mdc
    • Router implementation → @.cursor/rules/2102-router.mdc
    • Schema definition → @.cursor/rules/2101-schema-prisma.mdc
    • End-to-end feature specs → @.cursor/rules/2100-spec.mdc
    • tRPC React Query integration → @.cursor/rules/2103-trpc-react-query.mdc
  3. Conduct comprehensive codebase exploration: I'll systematically search for and identify all relevant files and components that contribute to the feature, including:

    • Entry points and main components
    • State management
    • API interactions
    • Utility functions
    • Types and interfaces
    • Configuration files
  4. Generate a structured documentation with these sections:

    • Feature Overview: High-level description of the feature's purpose and functionality
    • Core Files Map: List of essential files with their paths and a brief description of their role
    • Data Flow: How data moves through the system for this feature
    • Key Dependencies: External libraries or internal services the feature relies on
    • Configuration Options: Any configurable aspects of the feature
    • Extension Points: How the feature can be extended or customized
    • Implementation References: Links to relevant sections in existing documentation that were used or should be followed
  5. Include code snippets for critical sections with line numbers and file paths in the format:

    // Code snippet here
    
  6. Create a visual representation of the component hierarchy or data flow if applicable (described in text format that can be converted to a diagram).

  7. Summarize implementation patterns used in the feature that should be followed when extending it, referencing existing documentation where applicable:

    • Authentication patterns if the feature requires protection
    • CRUD patterns if the feature involves data operations
    • Error handling patterns
    • Router implementation patterns
    • Schema patterns
    • React Query patterns

The final documentation will be comprehensive enough that someone could continue development on this feature with minimal additional context beyond the generated document and the referenced existing documentation.