Skip to content

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

5 Commits
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

Revoact Banner

Revoact β€” Vibe Coding Skill Pack

Turn raw ideas into production-grade documentation in minutes, not hours.
Six modular AI skills that interview you first, then generate PRDs, Architecture docs, Technical Designs, Roadmaps, READMEs, and Security reviews β€” all in clean, industry-standard Markdown.

License: MIT Skills: 6 Interview-First Workflow Platform Compatibility Vibe Coding


πŸ“š Table of Contents


πŸ’‘ Why Revoact?

Most developers treat documentation as an afterthought β€” a chore that produces vague specs, incomplete architecture write-ups, and security sections filled with [TBD]. Revoact flips the script:

Traditional Approach Revoact Approach
❌ Blank-page paralysis β€” staring at an empty Markdown file βœ… Guided interview β€” the AI asks the right questions first
❌ Inconsistent formatting across teams and projects βœ… Industry-standard templates (C4, STRIDE, ADR, MoSCoW)
❌ Placeholder-heavy documents nobody reads βœ… Complete, actionable artifacts ready for stakeholder review
❌ One monolithic "docs" prompt that hallucinates details βœ… Six focused skills, each a domain expert in its artifact

The result: Your AI assistant becomes a disciplined engineering partner that gathers context, resolves ambiguity, and produces documents you'd be proud to share with your CTO.


πŸ“¦ Quick Skill Matrix

# Skill Folder Output Artifact What It Captures
1 PRD Generator skills/prd-doc/ PRD.md Problem statements Β· User personas Β· Functional requirements (MoSCoW) Β· Success metrics Β· User stories with acceptance criteria
2 Architecture Doc skills/architecture-doc/ ARCHITECTURE.md C4 diagrams (Context β†’ Component) Β· Data flow Β· Infrastructure & deployment Β· ADRs Β· Scalability roadmap
3 Technical Design Doc skills/design-doc/ DESIGN.md API contracts Β· Data models & schemas Β· Sequence diagrams Β· Migration plans Β· Failure modes & edge cases
4 Roadmap Builder skills/roadmap-doc/ ROADMAP.md Phased milestones (Q1–Q4) Β· Dependencies & critical path Β· Deliverable schedules Β· Risk mitigation matrix
5 README Generator skills/readme-doc/ README.md Visual headers & badges Β· Installation guides Β· Feature highlights Β· Env variable specs Β· Usage & API examples
6 Security & Compliance skills/security-doc/ SECURITY.md STRIDE threat modeling Β· OWASP Top 10 mitigations Β· AuthN/AuthZ design Β· Data encryption Β· Compliance (GDPR/SOC 2/HIPAA)

⚑ How It Works β€” The Interview-First Workflow

Every Revoact skill follows the same Interview β†’ Synthesize β†’ Generate pattern, ensuring your AI never guesses when it can ask:

flowchart LR
    A["πŸ—£οΈ Your Prompt"] --> B["πŸ” Skill Activation"]
    B --> C["🎀 Clarifying Interview\n3–5 Targeted Questions"]
    C --> D["🧠 Context Synthesis\n+ Codebase Scan"]
    D --> E["πŸ“„ Production Artifact\nComplete Markdown β€” Zero Placeholders"]
    E --> F["πŸ”„ Iterate & Refine"]

    style A fill:#1a1a2e,stroke:#e94560,color:#fff
    style B fill:#1a1a2e,stroke:#0f3460,color:#fff
    style C fill:#1a1a2e,stroke:#e94560,color:#fff
    style D fill:#1a1a2e,stroke:#0f3460,color:#fff
    style E fill:#1a1a2e,stroke:#16c79a,color:#fff
    style F fill:#1a1a2e,stroke:#16c79a,color:#fff
Loading

Step by Step

Step What Happens Example
1. Trigger Ask your AI to generate a document "Create a PRD for an AI-powered chat app"
2. Interview The skill reviews existing files, then asks 3–5 high-impact questions to clarify missing context "Who is the primary user persona? What's the target launch quarter?"
3. Generate A structured, industry-standard Markdown document is produced β€” no [TBD] placeholders Full PRD with problem statement, user stories, metrics, and risk table
4. Iterate Request edits, expansions, or follow-up documents naturally "Add a Phase 2 scope section" or "Now generate the ARCHITECTURE.md"

πŸ” Included Skills β€” Deep Dive

πŸ“‹ PRD Generator Β· skills/prd-doc/

Transforms raw ideas into comprehensive Product Requirements Documents.

  • Focus: Defines what to build and why it matters.
  • Key Sections: Executive Summary Β· Problem Statement Β· Goals & Success Metrics Β· User Stories with Acceptance Criteria Β· Functional Requirements (MoSCoW) Β· Non-Functional Requirements Β· Assumptions & Risks Β· Timeline & Milestones
  • Best For: Kicking off a new feature, aligning stakeholders, writing investor-ready specs.

πŸ—οΈ Architecture Doc Generator Β· skills/architecture-doc/

Drafts high-level system architecture documentation for complex software systems.

  • Focus: Defines how components interact at scale.
  • Key Sections: System Overview Β· C4 Diagrams (Context, Container, Component) Β· Architectural Principles Β· Data Architecture Β· Infrastructure & Deployment Β· Cross-Cutting Concerns (Auth, Logging, Monitoring) Β· Embedded ADRs Β· Future Scalability Roadmap
  • Best For: Onboarding new engineers, preparing for architecture reviews, documenting cloud infrastructure.

🎨 Technical Design Doc Generator · skills/design-doc/

Creates feature-level technical specifications prior to writing code.

  • Focus: Defines implementation details for specific features.
  • Key Sections: System Interfaces Β· Data Models & Schemas Β· API Endpoint Contracts Β· Sequence Diagrams Β· Migration Plans Β· Failure Modes & Edge Cases Β· Performance Considerations
  • Best For: Pre-implementation planning, API design sessions, communicating trade-offs to the team.

πŸ—ΊοΈ Product Roadmap Builder Β· skills/roadmap-doc/

Structures long-term product strategies and phased release schedules.

  • Focus: Defines when features will be delivered and in what order.
  • Key Sections: Strategic Themes Β· Phased Release Milestones (Q1–Q4 / Phase 1–3) Β· Dependencies & Critical Path Β· Deliverables per Phase Β· Risk Assessment & Mitigation
  • Best For: Sprint planning, executive presentations, coordinating cross-team dependencies.

πŸ“ README Generator Β· skills/readme-doc/

Generates attractive, developer-friendly repository READMEs.

  • Focus: Defines first impressions and quickstart developer onboarding.
  • Key Sections: Visual Header & Badges Β· Features List Β· Quick Start & Prerequisites Β· Installation Β· Environment Variable Documentation Β· Usage & API Examples Β· Contributing Guide Β· License
  • Best For: Open-source projects, internal tool launches, developer experience polish.

πŸ›‘οΈ Security & Compliance Review Β· skills/security-doc/

Establishes clear security postures, threat models, and compliance readiness.

  • Focus: Defines how the system is protected against threats.
  • Key Sections: STRIDE Threat Model Β· Security Controls Β· AuthN/AuthZ Protocols Β· Data Encryption (at Rest & in Transit) Β· OWASP Top 10 Mitigations Β· Compliance Mapping (GDPR, SOC 2, HIPAA) Β· Incident Response Plan Β· Vulnerability Management
  • Best For: Security audits, compliance certifications, investor due diligence, enterprise customer onboarding.

πŸ“ Repository Structure

Vibe Coding Pack/
β”œβ”€β”€ README.md                    # You are here
β”œβ”€β”€ LICENSE                      # MIT License
β”œβ”€β”€ package.json                 # npm package config (for npx revoact)
β”œβ”€β”€ Revoact Logo.png             # Branding banner
β”œβ”€β”€ bin/
β”‚   └── revoact.js               # CLI installer (zero dependencies)
└── skills/                      # All 6 skills live here
    β”œβ”€β”€ prd-doc/                  # β†’ PRD.md
    β”‚   └── SKILL.md             #   (462 lines of structured guidance)
    β”œβ”€β”€ architecture-doc/         # β†’ ARCHITECTURE.md
    β”‚   └── SKILL.md             #   (933 lines β€” C4, ADR, infra templates)
    β”œβ”€β”€ design-doc/               # β†’ DESIGN.md
    β”‚   └── SKILL.md             #   (668 lines β€” API, schema, sequence diagrams)
    β”œβ”€β”€ roadmap-doc/              # β†’ ROADMAP.md
    β”‚   └── SKILL.md             #   (87 lines β€” lean & focused)
    β”œβ”€β”€ readme-doc/               # β†’ README.md
    β”‚   └── SKILL.md             #   (860 lines β€” badges, env vars, onboarding)
    └── security-doc/             # β†’ SECURITY.md
        └── SKILL.md             #   (781 lines β€” STRIDE, OWASP, compliance)

Total: ~3,800 lines of curated, production-tested prompt engineering across 6 skills.


πŸ”§ Installation

One-Command Install (Recommended)

Install all 6 skills to your preferred AI agent with a single command β€” no cloning required:

npx revoact-skills

The interactive installer will ask where to place the skills:

  ╔══════════════════════════════════════════╗
  β•‘       Revoact β€” Vibe Coding Pack         β•‘
  β•‘   AI Documentation Skills Installer      β•‘
  β•šβ•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•

  Where would you like to install the skills?

    1)  Claude Code          ~/.claude/skills
    2)  Antigravity / Gemini  ~/.gemini/config/skills
    3)  Current project       .agents/skills
    4)  Custom path

  Select (1-4):

Non-Interactive Flags

Skip the menu with direct flags β€” perfect for CI, scripts, or quick setups:

# Install to Claude Code
npx revoact-skills --claude

# Install to Antigravity / Gemini
npx revoact-skills --gemini

# Install to current project
npx revoact-skills --project

# Install to a custom directory
npx revoact-skills --path ./my-custom-skills

# Skip confirmation prompt
npx revoact-skills --claude --yes

Other CLI Commands

# List all included skills
npx revoact-skills --list

# Show help
npx revoact-skills --help

Manual Install (Alternative)

If you prefer to clone the repo and copy files manually:

Claude Code

Windows (PowerShell)

xcopy /E /I "skills" "$env:USERPROFILE\.claude\skills"

macOS & Linux

cp -r skills/* ~/.claude/skills/
Antigravity & Custom Agents

Windows (PowerShell)

xcopy /E /I "skills" "$env:USERPROFILE\.gemini\config\skills"

macOS & Linux

cp -r skills/* ~/.gemini/config/skills/
Project-Scoped

Copy into .agents/skills/ at your workspace root:

Windows (PowerShell)

xcopy /E /I "skills" ".agents\skills"

macOS & Linux

cp -r skills/* .agents/skills/

πŸ’¬ Usage Examples

Once installed, invoke any skill naturally within your AI conversation:

Skill Example Prompt
PRD "Create a PRD for a real-time collaborative whiteboard app."
Architecture "Generate an architecture document for a multi-tenant SaaS backend on AWS."
Design Doc "Write a technical design doc for our OAuth2 + WebAuthn authentication service."
Roadmap "Build a 4-quarter product roadmap for scaling our e-commerce platform."
README "Draft a professional README for this open-source Rust CLI tool."
Security "Generate a SECURITY.md covering threat modeling and GDPR compliance for our healthcare application."

Chaining Skills

Revoact skills are designed to flow naturally from one to the next:

PRD.md  β†’  ARCHITECTURE.md  β†’  DESIGN.md  β†’  ROADMAP.md
  ↕              ↕                  ↕             ↕
README.md ←←←←←←←←←←←←←←←←←←←←←←←←←←←←  SECURITY.md

Start with a PRD to define what and why, then cascade into architecture, design, and roadmap. Generate the README and security docs in parallel at any stage.


✨ Core Features

Feature Description
🎯 Context-Aware Interviewing Asks precise, high-impact questions to fill gaps before generating documentation β€” never guesses.
πŸ“ Industry-Standard Formatting Incorporates C4 diagrams, STRIDE threat matrices, ADR records, MoSCoW prioritization, and OWASP mappings.
πŸ€– Cross-LLM Compatibility Works seamlessly across Claude, Antigravity, Gemini, GPT, and any SKILL.md-compatible coding agent.
⚑ Zero-Placeholder Policy Generates complete, actionable documents. No generic [TBD] fillers β€” asks you instead.
πŸ› οΈ Modular & Extensible Each skill is a standalone SKILL.md file. Adapt, extend, or compose them to match your team's standards.
πŸ”— Chainable Workflow Skills reference each other naturally. Generate a PRD, then cascade into architecture, design, and roadmap.

Skill Authoring Guidelines

  • Follow the YAML frontmatter format (name, description)
  • Include a clear "When to Use" trigger section
  • Provide a structured template with all sections
  • Add best practices and common mistakes to avoid
  • Keep the interview step with 3–5 targeted questions

πŸ“„ License

This project is licensed under the MIT License β€” see the LICENSE file for full details.

You are free to use, modify, distribute, and build upon these skills in personal and commercial projects.


🌐 About & Vibe Coding Philosophy

"Code is ephemeral now and libraries are over, ask your LLM to change it in whatever way you like."

Revoact was born from a vibe coding experiment β€” evaluating LLM performance side-by-side during deep technical research. It stands as a practical demonstration that structured prompts and skill wrappers turn raw LLMs into disciplined engineering partners.

The philosophy is simple: don't fight the AI, choreograph it. Give it domain expertise through well-crafted skill files, guide it with interviews instead of one-shot prompts, and let it produce documents that meet the same bar as a senior engineer's best work.

Feel free to use, fork, and adapt these skills for your own AI workflows.


⭐ Star this repo if Revoact saves you time. It helps others discover it.

Built with ❀️ for the AI-assisted development community

About

AI-powered skill pack for generating professional documentation, including PRDs, architecture, design docs, roadmaps, and READMEs

Topics

Resources

Stars

Watchers

Forks

Releases

Packages

Contributors

Languages