PromptBase
Upgrade
Close icon
General
Home
Marketplace
Create
Hire
Login
Chat
Sell
Explore

Prompt Details

Model
Chat - (gpt-5.5)
Token size
1,149
Example input
[PROJECT_NAME]: TaskFlow Pro [TECH_STACK]: React, TypeScript, Node.js, Express, PostgreSQL, Redis, Docker, GitHub Actions, AWS [SYSTEM_ARCHITECTURE]: Modular Monolith with REST APIs [CODEBASE_STRUCTURE]: Monorepo [HANDOFF_GOAL]: Team Transition
Example output
A. PROJECT CONTEXT Project Overview Business Purpose TaskFlow Pro is a cloud-based project management platform that helps distributed teams manage tasks, collaborate on projects, and track productivity from a single dashboard. Product Objectives Centralize project management Improve team collaboration Reduce manual reporting Provide real-time progress visibility Enable secure enterprise access Primary Users Project Managers Team Members Department Heads Organization Administrators Key Business Workflows User Authentication Workspace Creation Project Creation Task Assignment Activity Tracking Notification Delivery Analytics Dashboard System Boundaries Included: Web Application REST API Authentication Notification System Analytics External: Email Service AWS S3 Stripe Billing Slack Integration B. SOFTWARE ARCHITECTURE REVIEW Architecture Blueprint Overall Architecture Modular Monolith following Domain-Driven Design principles. React Frontend │ REST API │ Express Backend │ Business Services │ Repositories │ PostgreSQL Application Layers Presentation Layer ↓ API Layer ↓ Business Logic Layer ↓ Repository Layer ↓ Database Layer Design Patterns Repository Pattern Service Layer Dependency Injection Factory Pattern Strategy Pattern Middleware Pattern External Dependencies PostgreSQL Redis AWS S3 Stripe Slack SendGrid C. CODEBASE STRUCTURE ANALYSIS Codebase Map taskflow-pro/ apps/ frontend/ backend/ packages/ ui/ shared/ config/ database/ migrations/ seeds/ docs/ scripts/ docker/ .github/ Configuration Files .env docker-compose.yml package.json tsconfig.json eslint.config.js prettier.config.js Environment Variables DATABASE_URL REDIS_URL JWT_SECRET AWS_BUCKET STRIPE_SECRET SMTP_HOST Build System npm Workspaces TypeScript Compiler GitHub Actions Docker D. COMPONENT KNOWLEDGE CATALOG Authentication Module Business Purpose Secure user login and account protection. Technical Responsibility JWT generation Password hashing Session validation OAuth integration Inputs Email Password OAuth Token Outputs JWT Refresh Token User Session Dependencies PostgreSQL Redis JWT Library Failure Scenarios Invalid credentials Expired token Database unavailable Known Limitations No MFA support OAuth limited to Google E. DATA FLOW & INTEGRATION MAP System Interaction Map Browser │ REST API │ Authentication Middleware │ Business Services │ Repositories │ PostgreSQL ↓ Redis Cache ↓ AWS S3 ↓ Stripe ↓ Slack Authentication Flow User Login ↓ Password Verification ↓ JWT Generated ↓ Redis Session Stored ↓ Authenticated Requests Error Handling Centralized Error Middleware Structured JSON Responses Correlation IDs Retry Logic F. TECHNICAL DEBT & MAINTAINABILITY REVIEW High Priority User Service Issue: Over 3,000 lines in a single file. Impact: High Effort: Medium Recommendation: Split into domain-specific services. API Validation Issue: Manual validation duplicated across controllers. Impact: High Effort: Low Recommendation: Adopt centralized schema validation. Security Issue: JWT secret stored manually. Recommendation: Move to AWS Secrets Manager. G. DEVELOPER HANDOFF PLAYBOOK Local Setup git clone repository npm install cp .env.example .env docker compose up npm run migrate npm run dev Development Workflow Feature Branch ↓ Pull Request ↓ Code Review ↓ CI Checks ↓ Merge ↓ Deployment Coding Standards TypeScript Strict Mode ESLint Prettier Conventional Commits Unit Tests Required Deployment Checklist Database Migration Complete Tests Passing Environment Variables Verified Monitoring Enabled Rollback Plan Prepared H. DEVELOPER ONBOARDING ROADMAP Day 1 Learning Goals Understand product purpose Run project locally Review architecture Read README Architecture Guide API Documentation Task Fix one small UI bug. Success Submit first Pull Request. Week 1 Learn Backend architecture Database schema Authentication Task Implement one API endpoint. Weeks 2–4 Learn Business workflows Deployment CI/CD Monitoring Task Deliver one production-ready feature. First 90 Days Goals Own one service Participate in architecture reviews Improve documentation Mentor newer developers Success Independent feature ownership. I. KNOWLEDGE TRANSFER SCORECARD Architecture Documentation: 9/10 Codebase Clarity: 8/10 Maintainability: 8/10 Documentation Completeness: 7/10 Developer Onboarding: 9/10 Operational Readiness: 8/10 Knowledge Continuity: 9/10 Overall Knowledge Transfer Score 58/70 (≈83/100) J. EXECUTIVE ENGINEERING HANDOFF REPORT Project Summary TaskFlow Pro is a modular project management SaaS with a well-structured architecture, clear domain separation, and mature deployment pipeline. The codebase is suitable for team transitions, though several legacy areas require refactoring to improve long-term maintainability. Top 10 Architecture Insights Modular monolith enables simpler deployment while maintaining domain separation. Clear service and repository layers improve maintainability. Shared packages reduce code duplication. Redis improves session and cache performance. REST APIs are consistently organized. CI/CD is automated through GitHub Actions. Docker provides reproducible development environments. PostgreSQL is the single source of truth for transactional data. External integrations are isolated behind service abstractions. TypeScript strict mode enhances code reliability. Top 5 Technical Risks Large service classes increase maintenance complexity. Limited automated integration testing. Secrets management should be centralized. Missing multi-factor authentication for enterprise users. Tight coupling in notification workflows may hinder scaling. Top 5 Documentation Gaps Architecture Decision Records (ADRs). Database schema diagrams. Sequence diagrams for authentication and task workflows. Disaster recovery and rollback documentation. Third-party integration setup guides. Top 5 Maintainability Improvements Refactor oversized services into smaller domain modules. Adopt centralized request validation. Increase integration and end-to-end test coverage. Introduce automated dependency and security scanning. Expand operational runbooks for common incidents. Knowledge Transfer Score 83/100 Most Important System to Document Next The Authentication and Authorization subsystem, including login flows, token lifecycle, permission model, and identity integrations, because it underpins every application workflow and is critical for security and onboarding. One Rule for All Future Engineering Handoffs Document the rationale behind architectural decisions—not just the implementation—so future engineers understand why the system was built the way it was and can evolve it confidently without introducing unnecessary complexity.
🤖 GPT

Codebase Knowledge Transfer

Add to Cart
Instant accessInstant access
Usage rightsCommercial use
Money-back guaranteeMoney‑back
By purchasing this prompt, you agree to our terms of service
GPT-5.5
Tested icon
Guide icon
4 examples icon
Free credits icon
Software projects shouldn't depend on one developer's memory. This prompt helps engineering teams document architecture, map codebases, explain system components, capture technical debt, create onboarding plans, and standardize developer handoffs for long-term maintainability. Whether you're handing a project to a client, onboarding a new engineer, or preparing for team transitions, this prompt creates a structured knowledge transfer system that improves engineering continuity and reduces onboar
...more
Added 2 weeks ago
Report
Browse Marketplace