Skip to content

README.md

Latest commit

 

History

History
27 lines (20 loc) · 1.38 KB

README.md

File metadata and controls

27 lines (20 loc) · 1.38 KB

VibeCoding Template

A "Docs-First" AI Assistant Bootstrap Template designed for the Vibecoding development workflow.
This template structure forces AI coding assistants (GitHub Copilot, Cursor, Windsurf, etc.) to think before they code.

🚀 How to use this template

  1. Click "Use this template" to create a new repository.
  2. Edit PRD.md: defined your project requirements, target audience, and core features.
  3. Bootstrap your AI: Paste the contents of docs/AI_BOOTSTRAP.md into your AI chat window.
    • The AI will read the PRD and populate the docs/ folder with Architecture, Tech Stack, and a Plan before writing a single line of code.
  4. Review the Plan: Approve the docs generated by the AI.
  5. Start Coding: The AI will follow the docs/RULES.md and docs/PLAN.md to build your project.

📂 Structure

  • PRD.md: The source of truth for requirements.
  • docs/: The brain of the project.
    • AI_BOOTSTRAP.md: Instructions to wake up the AI.
    • RULES.md: Coding standards and persona for the AI.
    • CORE_IDEA.md / ARCH.md / TECH_STACK.md / PLAN.md: System artifacts managed by the AI.
  • docs/memory-bank/: Context management for the AI session.

🧠 Philosophy

"Docs First. Code Second." By forcing the AI to maintain architectural documentation, we prevent context drift and ensure robust, scalable applications.