generate_project_documentation – Project-Wide Documentation

Comprehensive project documentation generation with intelligent file discovery, architectural analysis, and developer-focused content creation

Perfect For

Team Onboarding and Knowledge Transfer
Create comprehensive documentation for new developers with setup guides, architecture overviews, and development workflows.

Open Source Project Documentation
Generate professional README files, API documentation, and contributor guides that encourage community participation.

Client Project Handover
Professional documentation packages for client delivery including technical specifications, maintenance guides, and deployment instructions.

Internal Documentation Standards
Establish consistent documentation across all company projects with standardised formats and comprehensive coverage.

Technical Specification Creation
Generate detailed technical documentation for stakeholder reviews, architectural decisions, and project planning.

Quick Start

Use Houtini LM to generate comprehensive project documentation:

local-llm:generate_project_documentation with:
- projectPath: "C:/my-react-app"
- docStyle: "markdown"
- focusAreas: ["api", "architecture", "setup"]
- includeExamples: true

Focus on API documentation:

local-llm:generate_project_documentation with:
- files: ["C:/api/routes/users.js", "C:/api/routes/auth.js"]
- docStyle: "markdown"
- focusAreas: ["api"]
- analysisDepth: "comprehensive"

Documentation Output

Executive Summary

• Project Overview: Purpose, key features, target audience, and technology stack summary
• Quick Start Guide: Installation, configuration, and first-run instructions for immediate productivity
• Architecture Summary: High-level system design, component relationships, and data flow overview

Technical Documentation

• API Reference: Complete endpoint documentation with request/response examples and authentication details
• Component Documentation: Individual module documentation with interfaces, methods, and usage examples
• Configuration Guide: Environment setup, build processes, deployment procedures, and troubleshooting

Developer Resources

• Development Workflow: Git practices, testing procedures, code review processes, and deployment pipelines
• Contributing Guidelines: Code standards, pull request procedures, and development environment setup
• Troubleshooting Guide: Common issues, debugging procedures, and performance optimisation tips

Documentation Example

Generated README Structure

# Project Name

## Overview
A modern React application for user management with Node.js API backend.

## Quick Start
```bash
npm install
npm run dev
```

## Architecture
- Frontend: React 18 with TypeScript
- Backend: Node.js with Express
- Database: PostgreSQL with Prisma ORM
- Authentication: JWT with refresh tokens

## API Endpoints
### Authentication
- POST /api/auth/login - User authentication
- POST /api/auth/refresh - Token refresh

### Users
- GET /api/users - List all users
- POST /api/users - Create new user
- PUT /api/users/:id - Update user

## Development
### Prerequisites
- Node.js 18+
- PostgreSQL 13+
- npm or yarn

### Environment Setup
1. Copy .env.example to .env
2. Configure database connection
3. Run database migrations

## Deployment
### Production Build
```bash
npm run build
npm run start
```

API Documentation Sample

### POST /api/users
Create a new user account.

**Request Body:**
```json
{
  "email": "user@example.com",
  "password": "securePassword123",
  "name": "John Doe"
}
```

**Response (201 Created):**
```json
{
  "id": "uuid-here",
  "email": "user@example.com",
  "name": "John Doe",
  "createdAt": "2024-01-15T10:30:00Z"
}
```

**Error Responses:**
- 400: Validation error
- 409: Email already exists

Parameters

Focus Areas Configuration

• api: Complete API documentation with endpoints, parameters, and response examples
• architecture: System design, component relationships, and architectural decision documentation
• setup: Installation, configuration, and development environment documentation
• contributing: Developer guidelines, code standards, and contribution procedures

Advanced Configuration

Use Houtini LM for professional documentation creation: Start with comprehensive analysis for complete coverage, then focus on specific areas for detailed documentation.

// Complete project documentation
local-llm:generate_project_documentation with:
- projectPath: "C:/enterprise-app"
- docStyle: "markdown"
- focusAreas: ["api", "architecture", "setup", "contributing"]
- includeExamples: true
- analysisDepth: "comprehensive"
- maxDepth: 4

// API-focused documentation
local-llm:generate_project_documentation with:
- projectPath: "C:/api-service"
- docStyle: "jsdoc"
- focusAreas: ["api"]
- includeExamples: true
- analysisDepth: "detailed"

Documentation Workflow:

1. Run analyze_project_structure for architectural insights
2. Generate comprehensive project documentation
3. Review and customise generated content for your audience
4. Use generate_documentation for specific component deep dives
5. Maintain documentation with regular regeneration as project evolves

Pro Tips

Audience-Specific Documentation: Tailor focus areas and depth to your audience – technical teams need architecture details, while stakeholders prefer overview and business value.

Living Documentation: Regenerate documentation regularly as your project evolves to maintain accuracy and relevance for team members.

Example-Driven Approach: Always include practical examples – they make documentation more useful and reduce onboarding time significantly.

Related Functions

• generate_documentation – Detailed documentation for specific files or components
• analyze_project_structure – Architectural insights for comprehensive documentation
• count_files – Project overview and structure for documentation planning
• security_audit – Security considerations for documentation and deployment guides