{"_id":"@arsudsandesh97/revoact","name":"@arsudsandesh97/revoact","dist-tags":{"latest":"1.0.0"},"versions":{"1.0.0":{"name":"@arsudsandesh97/revoact","version":"1.0.0","description":"AI-powered documentation skills for modern development workflows. Generate PRDs, Architecture docs, Design specs, Roadmaps, READMEs, and Security reviews through interactive AI interviews.","keywords":["ai","vibe-coding","documentation","prd","architecture","design-doc","roadmap","security","claude","antigravity","gemini","skills","agent-skills","llm","developer-tools"],"author":{"name":"Revoact"},"license":"MIT","repository":{"type":"git","url":""},"bin":{"revoact":"bin/revoact.js"},"engines":{"node":">=14.0.0"},"_id":"@arsudsandesh97/revoact@1.0.0","_nodeVersion":"24.18.0","_npmVersion":"11.16.0","dist":{"integrity":"sha512-9pFg5j1gli/zgHJl0T28SWqrnCGwTfPWkEA5ZG+2gHDQ+5TOmV2EW6znAzFR1KpLWrAAwCaM69mCSuKgy2I/bw==","shasum":"259035157987c83beb88d37062b46653e56e989b","tarball":"https://registry.npmjs.org/@arsudsandesh97/revoact/-/revoact-1.0.0.tgz","fileCount":10,"unpackedSize":144400,"signatures":[{"keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U","sig":"MEUCIQDZWOXBnBJLvMrQV5nLF32XGIKHvzdV0sqOoR3iUy/yWQIgQV1XjgAF8LAMKRuwNHmSoO8nJzPyKgL0HilUmS2/HIQ="}]},"_npmUser":{"name":"arsudsandesh97","email":"arsudsandesh97@gmail.com"},"directories":{},"maintainers":[{"name":"arsudsandesh97","email":"arsudsandesh97@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages-npm-production","tmp":"tmp/revoact_1.0.0_1784735253786_0.785730776964048"},"_hasShrinkwrap":false}},"time":{"created":"2026-07-22T15:47:33.666Z","1.0.0":"2026-07-22T15:47:33.948Z","modified":"2026-07-22T15:47:34.183Z"},"maintainers":[{"name":"arsudsandesh97","email":"arsudsandesh97@gmail.com"}],"description":"AI-powered documentation skills for modern development workflows. Generate PRDs, Architecture docs, Design specs, Roadmaps, READMEs, and Security reviews through interactive AI interviews.","keywords":["ai","vibe-coding","documentation","prd","architecture","design-doc","roadmap","security","claude","antigravity","gemini","skills","agent-skills","llm","developer-tools"],"repository":{"type":"git","url":""},"author":{"name":"Revoact"},"license":"MIT","readme":"

\n \"Revoact\n

\n\n

Revoact β€” Vibe Coding Skill Pack

\n\n

\n Turn raw ideas into production-grade documentation in minutes, not hours.
\n 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.\n

\n\n

\n \"License:\n \"Skills:\n \"Interview-First\n \"Platform\n \"Vibe\n

\n\n---\n\n## πŸ“š Table of Contents\n\n- [Why Revoact?](#-why-revoact)\n- [Quick Skill Matrix](#-quick-skill-matrix)\n- [How It Works β€” The Interview-First Workflow](#-how-it-works--the-interview-first-workflow)\n- [Included Skills β€” Deep Dive](#-included-skills--deep-dive)\n- [Repository Structure](#-repository-structure)\n- [Installation](#-installation)\n- [Usage Examples](#-usage-examples)\n- [Core Features](#-core-features)\n- [Contributing](#-contributing)\n- [License](#-license)\n- [About & Vibe Coding Philosophy](#-about--vibe-coding-philosophy)\n\n---\n\n## πŸ’‘ Why Revoact?\n\nMost 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:\n\n| Traditional Approach | Revoact Approach |\n| :--- | :--- |\n| ❌ Blank-page paralysis β€” staring at an empty Markdown file | βœ… Guided interview β€” the AI asks the right questions first |\n| ❌ Inconsistent formatting across teams and projects | βœ… Industry-standard templates (C4, STRIDE, ADR, MoSCoW) |\n| ❌ Placeholder-heavy documents nobody reads | βœ… Complete, actionable artifacts ready for stakeholder review |\n| ❌ One monolithic \"docs\" prompt that hallucinates details | βœ… Six focused skills, each a domain expert in its artifact |\n\n> **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.\n\n---\n\n## πŸ“¦ Quick Skill Matrix\n\n| # | Skill | Folder | Output Artifact | What It Captures |\n| :---: | :--- | :--- | :--- | :--- |\n| 1 | **PRD Generator** | `skills/prd-doc/` | `PRD.md` | Problem statements Β· User personas Β· Functional requirements (MoSCoW) Β· Success metrics Β· User stories with acceptance criteria |\n| 2 | **Architecture Doc** | `skills/architecture-doc/` | `ARCHITECTURE.md` | C4 diagrams (Context β†’ Component) Β· Data flow Β· Infrastructure & deployment Β· ADRs Β· Scalability roadmap |\n| 3 | **Technical Design Doc** | `skills/design-doc/` | `DESIGN.md` | API contracts Β· Data models & schemas Β· Sequence diagrams Β· Migration plans Β· Failure modes & edge cases |\n| 4 | **Roadmap Builder** | `skills/roadmap-doc/` | `ROADMAP.md` | Phased milestones (Q1–Q4) Β· Dependencies & critical path Β· Deliverable schedules Β· Risk mitigation matrix |\n| 5 | **README Generator** | `skills/readme-doc/` | `README.md` | Visual headers & badges Β· Installation guides Β· Feature highlights Β· Env variable specs Β· Usage & API examples |\n| 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) |\n\n---\n\n## ⚑ How It Works β€” The Interview-First Workflow\n\nEvery Revoact skill follows the same **Interview β†’ Synthesize β†’ Generate** pattern, ensuring your AI never guesses when it can ask:\n\n```mermaid\nflowchart LR\n A[\"πŸ—£οΈ Your Prompt\"] --> B[\"πŸ” Skill Activation\"]\n B --> C[\"🎀 Clarifying Interview\\n3–5 Targeted Questions\"]\n C --> D[\"🧠 Context Synthesis\\n+ Codebase Scan\"]\n D --> E[\"πŸ“„ Production Artifact\\nComplete Markdown β€” Zero Placeholders\"]\n E --> F[\"πŸ”„ Iterate & Refine\"]\n\n style A fill:#1a1a2e,stroke:#e94560,color:#fff\n style B fill:#1a1a2e,stroke:#0f3460,color:#fff\n style C fill:#1a1a2e,stroke:#e94560,color:#fff\n style D fill:#1a1a2e,stroke:#0f3460,color:#fff\n style E fill:#1a1a2e,stroke:#16c79a,color:#fff\n style F fill:#1a1a2e,stroke:#16c79a,color:#fff\n```\n\n### Step by Step\n\n| Step | What Happens | Example |\n| :---: | :--- | :--- |\n| **1. Trigger** | Ask your AI to generate a document | *\"Create a PRD for an AI-powered chat app\"* |\n| **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?\"* |\n| **3. Generate** | A structured, industry-standard Markdown document is produced β€” no `[TBD]` placeholders | Full PRD with problem statement, user stories, metrics, and risk table |\n| **4. Iterate** | Request edits, expansions, or follow-up documents naturally | *\"Add a Phase 2 scope section\"* or *\"Now generate the ARCHITECTURE.md\"* |\n\n---\n\n## πŸ” Included Skills β€” Deep Dive\n\n### πŸ“‹ PRD Generator Β· `skills/prd-doc/`\n\n> *Transforms raw ideas into comprehensive Product Requirements Documents.*\n\n- **Focus:** Defines *what* to build and *why* it matters.\n- **Key Sections:** Executive Summary Β· Problem Statement Β· Goals & Success Metrics Β· User Stories with Acceptance Criteria Β· Functional Requirements (MoSCoW) Β· Non-Functional Requirements Β· Assumptions & Risks Β· Timeline & Milestones\n- **Best For:** Kicking off a new feature, aligning stakeholders, writing investor-ready specs.\n\n---\n\n### πŸ—οΈ Architecture Doc Generator Β· `skills/architecture-doc/`\n\n> *Drafts high-level system architecture documentation for complex software systems.*\n\n- **Focus:** Defines *how components interact at scale*.\n- **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\n- **Best For:** Onboarding new engineers, preparing for architecture reviews, documenting cloud infrastructure.\n\n---\n\n### 🎨 Technical Design Doc Generator Β· `skills/design-doc/`\n\n> *Creates feature-level technical specifications prior to writing code.*\n\n- **Focus:** Defines *implementation details for specific features*.\n- **Key Sections:** System Interfaces Β· Data Models & Schemas Β· API Endpoint Contracts Β· Sequence Diagrams Β· Migration Plans Β· Failure Modes & Edge Cases Β· Performance Considerations\n- **Best For:** Pre-implementation planning, API design sessions, communicating trade-offs to the team.\n\n---\n\n### πŸ—ΊοΈ Product Roadmap Builder Β· `skills/roadmap-doc/`\n\n> *Structures long-term product strategies and phased release schedules.*\n\n- **Focus:** Defines *when features will be delivered and in what order*.\n- **Key Sections:** Strategic Themes Β· Phased Release Milestones (Q1–Q4 / Phase 1–3) Β· Dependencies & Critical Path Β· Deliverables per Phase Β· Risk Assessment & Mitigation\n- **Best For:** Sprint planning, executive presentations, coordinating cross-team dependencies.\n\n---\n\n### πŸ“ README Generator Β· `skills/readme-doc/`\n\n> *Generates attractive, developer-friendly repository READMEs.*\n\n- **Focus:** Defines *first impressions and quickstart developer onboarding*.\n- **Key Sections:** Visual Header & Badges Β· Features List Β· Quick Start & Prerequisites Β· Installation Β· Environment Variable Documentation Β· Usage & API Examples Β· Contributing Guide Β· License\n- **Best For:** Open-source projects, internal tool launches, developer experience polish.\n\n---\n\n### πŸ›‘οΈ Security & Compliance Review Β· `skills/security-doc/`\n\n> *Establishes clear security postures, threat models, and compliance readiness.*\n\n- **Focus:** Defines *how the system is protected against threats*.\n- **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\n- **Best For:** Security audits, compliance certifications, investor due diligence, enterprise customer onboarding.\n\n---\n\n## πŸ“ Repository Structure\n\n```text\nVibe Coding Pack/\nβ”œβ”€β”€ README.md # You are here\nβ”œβ”€β”€ LICENSE # MIT License\nβ”œβ”€β”€ package.json # npm package config (for npx revoact)\nβ”œβ”€β”€ Revoact Logo.png # Branding banner\nβ”œβ”€β”€ bin/\nβ”‚ └── revoact.js # CLI installer (zero dependencies)\n└── skills/ # All 6 skills live here\n β”œβ”€β”€ prd-doc/ # β†’ PRD.md\n β”‚ └── SKILL.md # (462 lines of structured guidance)\n β”œβ”€β”€ architecture-doc/ # β†’ ARCHITECTURE.md\n β”‚ └── SKILL.md # (933 lines β€” C4, ADR, infra templates)\n β”œβ”€β”€ design-doc/ # β†’ DESIGN.md\n β”‚ └── SKILL.md # (668 lines β€” API, schema, sequence diagrams)\n β”œβ”€β”€ roadmap-doc/ # β†’ ROADMAP.md\n β”‚ └── SKILL.md # (87 lines β€” lean & focused)\n β”œβ”€β”€ readme-doc/ # β†’ README.md\n β”‚ └── SKILL.md # (860 lines β€” badges, env vars, onboarding)\n └── security-doc/ # β†’ SECURITY.md\n └── SKILL.md # (781 lines β€” STRIDE, OWASP, compliance)\n```\n\n> **Total:** ~3,800 lines of curated, production-tested prompt engineering across 6 skills.\n\n---\n\n## πŸ”§ Installation\n\n### One-Command Install (Recommended)\n\nInstall all 6 skills to your preferred AI agent with a single command β€” no cloning required:\n\n```bash\nnpx @arsudsandesh97/revoact\n```\n\nThe interactive installer will ask where to place the skills:\n\n```\n ╔══════════════════════════════════════════╗\n β•‘ Revoact β€” Vibe Coding Pack β•‘\n β•‘ AI Documentation Skills Installer β•‘\n β•šβ•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•\n\n Where would you like to install the skills?\n\n 1) Claude Code ~/.claude/skills\n 2) Antigravity / Gemini ~/.gemini/config/skills\n 3) Current project .agents/skills\n 4) Custom path\n\n Select (1-4):\n```\n\n#### Non-Interactive Flags\n\nSkip the menu with direct flags β€” perfect for CI, scripts, or quick setups:\n\n```bash\n# Install to Claude Code\nnpx @arsudsandesh97/revoact --claude\n\n# Install to Antigravity / Gemini\nnpx @arsudsandesh97/revoact --gemini\n\n# Install to current project\nnpx @arsudsandesh97/revoact --project\n\n# Install to a custom directory\nnpx @arsudsandesh97/revoact --path ./my-custom-skills\n\n# Skip confirmation prompt\nnpx @arsudsandesh97/revoact --claude --yes\n```\n\n#### Other CLI Commands\n\n```bash\n# List all included skills\nnpx @arsudsandesh97/revoact --list\n\n# Show help\nnpx @arsudsandesh97/revoact --help\n```\n\n---\n\n### Manual Install (Alternative)\n\nIf you prefer to clone the repo and copy files manually:\n\n
\nClaude Code\n\n**Windows (PowerShell)**\n```powershell\nxcopy /E /I \"skills\" \"$env:USERPROFILE\\.claude\\skills\"\n```\n\n**macOS & Linux**\n```bash\ncp -r skills/* ~/.claude/skills/\n```\n
\n\n
\nAntigravity & Custom Agents\n\n**Windows (PowerShell)**\n```powershell\nxcopy /E /I \"skills\" \"$env:USERPROFILE\\.gemini\\config\\skills\"\n```\n\n**macOS & Linux**\n```bash\ncp -r skills/* ~/.gemini/config/skills/\n```\n
\n\n
\nProject-Scoped\n\nCopy into `.agents/skills/` at your workspace root:\n\n**Windows (PowerShell)**\n```powershell\nxcopy /E /I \"skills\" \".agents\\skills\"\n```\n\n**macOS & Linux**\n```bash\ncp -r skills/* .agents/skills/\n```\n
\n\n---\n\n## πŸ’¬ Usage Examples\n\nOnce installed, invoke any skill naturally within your AI conversation:\n\n| Skill | Example Prompt |\n| :--- | :--- |\n| **PRD** | *\"Create a PRD for a real-time collaborative whiteboard app.\"* |\n| **Architecture** | *\"Generate an architecture document for a multi-tenant SaaS backend on AWS.\"* |\n| **Design Doc** | *\"Write a technical design doc for our OAuth2 + WebAuthn authentication service.\"* |\n| **Roadmap** | *\"Build a 4-quarter product roadmap for scaling our e-commerce platform.\"* |\n| **README** | *\"Draft a professional README for this open-source Rust CLI tool.\"* |\n| **Security** | *\"Generate a SECURITY.md covering threat modeling and GDPR compliance for our healthcare application.\"* |\n\n### Chaining Skills\n\nRevoact skills are designed to flow naturally from one to the next:\n\n```text\nPRD.md β†’ ARCHITECTURE.md β†’ DESIGN.md β†’ ROADMAP.md\n ↕ ↕ ↕ ↕\nREADME.md ←←←←←←←←←←←←←←←←←←←←←←←←←←←← SECURITY.md\n```\n\n> 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.\n\n---\n\n## ✨ Core Features\n\n| Feature | Description |\n| :--- | :--- |\n| 🎯 **Context-Aware Interviewing** | Asks precise, high-impact questions to fill gaps before generating documentation β€” never guesses. |\n| πŸ“ **Industry-Standard Formatting** | Incorporates C4 diagrams, STRIDE threat matrices, ADR records, MoSCoW prioritization, and OWASP mappings. |\n| πŸ€– **Cross-LLM Compatibility** | Works seamlessly across Claude, Antigravity, Gemini, GPT, and any SKILL.md-compatible coding agent. |\n| ⚑ **Zero-Placeholder Policy** | Generates complete, actionable documents. No generic `[TBD]` fillers β€” asks you instead. |\n| πŸ› οΈ **Modular & Extensible** | Each skill is a standalone `SKILL.md` file. Adapt, extend, or compose them to match your team's standards. |\n| πŸ”— **Chainable Workflow** | Skills reference each other naturally. Generate a PRD, then cascade into architecture, design, and roadmap. |\n\n---\n\n### Skill Authoring Guidelines\n\n- Follow the YAML frontmatter format (`name`, `description`)\n- Include a clear \"When to Use\" trigger section\n- Provide a structured template with all sections\n- Add best practices and common mistakes to avoid\n- Keep the interview step with 3–5 targeted questions\n\n---\n\n## πŸ“„ License\n\nThis project is licensed under the **MIT License** β€” see the [LICENSE](LICENSE) file for full details.\n\nYou are free to use, modify, distribute, and build upon these skills in personal and commercial projects.\n\n---\n\n## 🌐 About & Vibe Coding Philosophy\n\n> *\"Code is ephemeral now and libraries are over, ask your LLM to change it in whatever way you like.\"*\n\nRevoact 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**.\n\nThe 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.\n\nFeel free to use, fork, and adapt these skills for your own AI workflows.\n\n---\n\n

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

\n\n

\n Built with ❀️ for the AI-assisted development community\n

","readmeFilename":"README.md","_rev":"1-4bea2a61db88922b000cde9e925ae90d"}