User Guides

Complete documentation for using RE-cue effectively

Welcome to the RE-cue user documentation! This collection of guides will help you master reverse engineering and documentation generation for your codebase.

Getting Started

New to RE-cue? Start here:

Getting Started Guide

Your first steps with RE-cue:

  • Installation - Set up RE-cue in 5 minutes
  • Quick Start - Generate your first documentation
  • Basic Usage - Learn core commands and options
  • Understanding Output - What each file contains
  • Common Questions - Answers to frequent questions

Perfect for: First-time users, quick setup, initial exploration

Core Documentation

Complete User Guide

Comprehensive reference for all RE-cue features:

  • Installation Options - Python, Bash, GitHub Action
  • Command Reference - All CLI commands and options
  • Generating Documentation - Feature specs, plans, data models, use cases, API contracts
  • Framework Support - Spring Boot, Rails, Express, Django, and more
  • Advanced Features - Phased analysis, interactive refinement, template customization
  • Workflow Integration - Local development, CI/CD, Git hooks
  • Optimization Tips - Performance tuning for large codebases
  • Troubleshooting - Common issues and solutions

Perfect for: Comprehensive reference, detailed feature documentation, troubleshooting

Advanced Topics

Advanced Usage Guide

Power-user techniques and workflows:

  • Advanced CLI - Complex analysis chains, environment configuration, batch processing
  • Custom Workflows - Pre/post-analysis processing, differential analysis, incremental updates
  • Large Codebase Optimization - Memory management, distributed analysis, filtering
  • Template System - Custom templates, Jinja2 usage, organization-specific formats
  • API Integration - Programmatic usage, REST API server, webhook integration
  • Multi-Project Analysis - Monorepo support, cross-project comparison
  • Custom Framework Support - Extend RE-cue with new frameworks
  • Performance Tuning - Profiling, optimization, configuration

Perfect for: Power users, complex projects, customization, integration

Best Practices

Best Practices Guide

Proven practices from experienced users:

  • Documentation Strategy - Goal-setting, versioning, treating docs as starting points
  • Code Preparation - Optimizing code for analysis, cleanup, annotations
  • Analysis Workflow - Progressive analysis, regular regeneration, validation
  • Output Quality - Enhancing generated docs, structuring documents, visual aids
  • Team Collaboration - Ownership, code review integration, knowledge sharing
  • CI/CD Integration - Automated checks, updates, release documentation
  • Maintenance - Regular audits, keeping RE-cue updated, archiving
  • Common Pitfalls - What to avoid and how to fix issues

Perfect for: Teams, production usage, workflow optimization, quality improvement

By User Type

New Users:

  1. Getting Started - Installation and first analysis
  2. User Guide - Installation - Choose your setup method
  3. User Guide - Generating Documentation - Create your first docs

Developers:

  1. User Guide - Command Reference - CLI commands
  2. Best Practices - Code Preparation - Optimize for analysis
  3. Advanced Usage - Custom Workflows - Automate your workflow

DevOps Engineers:

  1. User Guide - CI/CD Integration - Pipeline integration
  2. Best Practices - CI/CD Integration - Automated workflows
  3. Advanced Usage - API Integration - Programmatic usage

Team Leads:

  1. Best Practices - Documentation Strategy - Planning approach
  2. Best Practices - Team Collaboration - Team workflows
  3. User Guide - Framework Support - Technology compatibility

By Task

Installing RE-cue:

Running First Analysis:

Understanding Output:

Optimizing Performance:

Customizing Templates:

CI/CD Integration:

Troubleshooting:

Additional Resources

Documentation Types

Learn about what RE-cue generates:

Feature Specifications - Business-focused documentation

Implementation Plans - Technical architecture documentation

Data Models - Database and entity documentation

Use Cases - Business process documentation

  • User Guide - Use Cases
  • What: Actors, boundaries, workflows, business context
  • For: Business analysts, product owners, process designers

API Contracts - OpenAPI 3.0 specifications

  • User Guide - API Contracts
  • What: Endpoints, schemas, authentication, examples
  • For: API consumers, integration developers, QA engineers

Framework-Specific Guides

Developer Guides

Reference

Learning Paths

Path 1: Basic User (1 hour)

Get started with RE-cue basics:

  1. Install RE-cue (10 min)

  2. Run First Analysis (15 min)

  3. Understand Output (20 min)

  4. Review and Refine (15 min)

Path 2: Team Integration (3 hours)

Integrate RE-cue into team workflow:

  1. Setup CI/CD (45 min)

  2. Establish Workflow (60 min)

  3. Train Team (45 min)

  4. Review and Iterate (30 min)

    • Generate sample documentation
    • Review as team
    • Adjust workflow based on feedback

Path 3: Advanced Usage (5 hours)

Master advanced features:

  1. Template Customization (90 min)

  2. Performance Optimization (60 min)

  3. API Integration (90 min)

  4. Custom Framework Support (60 min)

Getting Help

Self-Service

  1. Search the Guides - Use browser search (Ctrl/Cmd + F)
  2. Check Troubleshooting - Troubleshooting Guide
  3. Review Framework Guides - Framework Documentation
  4. Check FAQ - Getting Started - Common Questions

Community Support

  1. GitHub Issues - Report bugs or request features
  2. Discussions - Ask questions and share experiences
  3. Contributing - Help improve RE-cue

What’s New

Latest Updates:

  • ✅ Complete user guide collection
  • ✅ Getting Started guide for new users
  • ✅ Advanced Usage guide for power users
  • ✅ Best Practices from experienced users
  • ✅ Framework-specific documentation
  • ✅ CI/CD integration guides

Coming Soon:

  • 📖 Video tutorials
  • 📖 Interactive examples
  • 📖 Case studies
  • 📖 Workshop materials

Ready to get started? Head to the Getting Started Guide →

GuideDescription
Getting Started with RE-cueQuick start guide to begin reverse engineering your codebase with RE-cue
Complete User GuideComprehensive guide to using RE-cue for reverse engineering and documentation generation
Advanced UsageAdvanced techniques and workflows for power users of RE-cue
Best PracticesProven practices and patterns for effective use of RE-cue
VS Code ExtensionComplete guide to using the RE-cue VS Code extension for in-editor code analysis
Parallel Processing for Faster Analysis
RE-cue User Guides
Troubleshooting Guide