documentation-create-developer

Developer Documentation Creation

This prompt generates comprehensive developer-focused documentation including development environment setup, architecture overviews, coding standards, contribution guidelines, and technical workflows.

🎯 DEVELOPER DOCUMENTATION OBJECTIVES:

1. ANALYZE codebase structure and generate setup documentation
2. CREATE comprehensive developer guides for onboarding and contribution
3. DOCUMENT architecture decisions and system design patterns
4. ESTABLISH coding standards and development workflows
5. GENERATE contribution guidelines and collaboration processes

🔧 DEVELOPMENT ENVIRONMENT ANALYSIS:

STEP 1: Technology Stack Discovery

Automated Stack Detection:

# Analyze project technology stack
echo "🔍 Analyzing Technology Stack..."

# Package managers and dependencies
echo "## Package Management:"
[ -f "package.json" ] && echo "- Node.js project (package.json found)"
[ -f "yarn.lock" ] && echo "- Yarn package manager"
[ -f "package-lock.json" ] && echo "- NPM package manager"
[ -f "pnpm-lock.yaml" ] && echo "- PNPM package manager"
[ -f "requirements.txt" ] && echo "- Python project (requirements.txt found)"
[ -f "Pipfile" ] && echo "- Python project with Pipenv"
[ -f "pyproject.toml" ] && echo "- Python project with Poetry"
[ -f "Gemfile" ] && echo "- Ruby project (Gemfile found)"
[ -f "Cargo.toml" ] && echo "- Rust project (Cargo.toml found)"
[ -f "go.mod" ] && echo "- Go project (go.mod found)"

# Framework detection
echo -e "\n## Frameworks and Libraries:"
if [ -f "package.json" ]; then
    grep -q "next" package.json && echo "- Next.js framework"
    grep -q "react" package.json && echo "- React library"
    grep -q "vue" package.json && echo "- Vue.js framework"
    grep -q "angular" package.json && echo "- Angular framework"
    grep -q "express" package.json && echo "- Express.js server"
    grep -q "fastify" package.json && echo "- Fastify server"
    grep -q "gatsby" package.json && echo "- Gatsby framework"
    grep -q "nuxt" package.json && echo "- Nuxt.js framework"
fi

# Development tools
echo -e "\n## Development Tools:"
[ -f "tsconfig.json" ] && echo "- TypeScript configuration"
[ -f ".eslintrc.js" ] || [ -f ".eslintrc.json" ] && echo "- ESLint linting"
[ -f "prettier.config.js" ] || [ -f ".prettierrc" ] && echo "- Prettier formatting"
[ -f "vitest.config.ts" ] && echo "- Vitest testing framework"
[ -f "jest.config.js" ] && echo "- Jest testing framework"
[ -f "cypress.config.js" ] && echo "- Cypress E2E testing"
[ -f "playwright.config.ts" ] && echo "- Playwright testing"
[ -f "tailwind.config.js" ] && echo "- Tailwind CSS"
[ -f "vite.config.ts" ] && echo "- Vite build tool"
[ -f "webpack.config.js" ] && echo "- Webpack bundler"

# Database and storage
echo -e "\n## Database and Storage:"
[ -f "prisma/schema.prisma" ] && echo "- Prisma ORM"
[ -f "drizzle.config.ts" ] && echo "- Drizzle ORM"
[ -f "knexfile.js" ] && echo "- Knex.js query builder"
grep -q "mongoose" package.json 2>/dev/null && echo "- MongoDB with Mongoose"
grep -q "pg" package.json 2>/dev/null && echo "- PostgreSQL"
grep -q "mysql" package.json 2>/dev/null && echo "- MySQL"

# Deployment and infrastructure
echo -e "\n## Deployment and Infrastructure:"
[ -f "Dockerfile" ] && echo "- Docker containerization"
[ -f "docker-compose.yml" ] && echo "- Docker Compose"
[ -f "vercel.json" ] && echo "- Vercel deployment"
[ -f "netlify.toml" ] && echo "- Netlify deployment"
[ -d ".github/workflows" ] && echo "- GitHub Actions CI/CD"
[ -f ".gitlab-ci.yml" ] && echo "- GitLab CI"
[ -f "serverless.yml" ] && echo "- Serverless framework"