bkit Document Templates

Use these templates when generating PDCA documents.

Available Templates

${CLAUDE_PLUGIN_ROOT}/templates/plan.template.md

${CLAUDE_PLUGIN_ROOT}/templates/design.template.md

${CLAUDE_PLUGIN_ROOT}/templates/analysis.template.md

${CLAUDE_PLUGIN_ROOT}/templates/report.template.md

${CLAUDE_PLUGIN_ROOT}/templates/_INDEX.template.md

${CLAUDE_PLUGIN_ROOT}/templates/CLAUDE.template.md

Template Usage

Plan Template

• Overview & Purpose
• Scope (In/Out)
• Requirements (Functional/Non-Functional)
• Success Criteria
• Risks & Mitigation

Design Template

• Architecture (diagrams, data flow)
• Data Model (entities, relationships)
• API Specification (endpoints, request/response)
• UI/UX Design (layouts, components)
• Error Handling
• Security Considerations
• Test Plan
• Implementation Guide

Analysis Template

• Design vs Implementation comparison
• Missing features
• Inconsistencies
• Quality metrics
• Recommendations

Report Template

• Summary of completed work
• Metrics (LOC, test coverage, etc.)
• Issues encountered
• Lessons learned
• Future improvements

Document Output Paths

docs/
├── 01-plan/
│   └── features/
│       └── {feature}.plan.md
├── 02-design/
│   └── features/
│       └── {feature}.design.md
├── 03-analysis/
│   └── features/
│       └── {feature}.analysis.md
└── 04-report/
    └── features/
        └── {feature}.report.md

Variable Substitution

{variable}

• {feature}

  : Feature name

• {date}

  : Creation date (YYYY-MM-DD)

• {author}

  : Document author

Pipeline Templates

• ${CLAUDE_PLUGIN_ROOT}/templates/pipeline/

  directory

Document Standards

File Naming Rules

{number}_{english_name}.md      # 01_system_architecture.md
{number}-{english_name}.md      # 01-system-architecture.md
{feature}.{type}.md             # login.design.md

Common Header

# {Document Title}

> **Summary**: {One-line description}
>
> **Author**: {Name}
> **Created**: {YYYY-MM-DD}
> **Last Modified**: {YYYY-MM-DD}
> **Status**: {Draft | Review | Approved | Deprecated}

---

Version Control

## Version History

| Version | Date | Changes | Author |
|---------|------|---------|--------|
| 1.0 | 2024-12-01 | Initial draft | Kay |
| 1.1 | 2024-12-05 | Added API spec | Kay |

Cross-References

## Related Documents
- Plan: [login.plan.md](../01-plan/features/login.plan.md)
- Design: [login.design.md](../02-design/features/login.design.md)
- Analysis: [login.analysis.md](../03-analysis/features/login.analysis.md)

Status Tracking

Conflict Resolution

• Code vs Design mismatch: Code is truth, suggest document update
• Multiple versions: Reference only the latest version