/devkit.generate-document

description: Generates professional documents (assessments, features, analysis, process, custom) with language support and specialized sub-agents. Use when you need to create structured technical or business documentation.
argument-hint: "--lang=en|it|es|fr|de --type=assessment|feature|analysis|process|custom [objective/description]"
allowed-tools: Task, Read, Write, Edit, Bash, Grep, Glob, TodoWrite, AskUserQuestion
model: inherit

Document Generation Command

Overview

Generate professional technical and business documents with multi-language support. This command analyzes your codebase and produces comprehensive, well-structured documentation based on the specified type and objective.

Usage

/devkit.generate-document $ARGUMENTS

Arguments

**Input received**: $ARGUMENTS

Current Context

• **Current Directory**: !`pwd`
• **Git Branch**: !`git branch --show-current`
• **Project Structure**: !`ls -la`

Integration with Sub-agents

This command leverages specialized sub-agents for different aspects:

| Phase | Agent | Purpose | |------------|--------------------------------------------------------|-----------------------------| | Analysis | `developer-kit:general-code-explorer` | Codebase exploration | | Analysis | `developer-kit:spring-boot-backend-development-expert` | Java/Spring analysis | | Analysis | `developer-kit:nestjs-backend-development-expert` | NestJS analysis | | Generation | `developer-kit:document-generator-expert` | Primary document generation | | Support | `developer-kit:java-security-expert` | Security domain expertise | | Support | `developer-kit:typescript-security-expert` | TypeScript security | | Support | `developer-kit:general-software-architect` | Architecture insights |

---

Parameters

| Parameter | Values | Default | Description | |------------|----------------------------------------------------------|--------------|-------------------| | `--lang` | `en`, `it`, `es`, `fr`, `de`, `pt` | `en` | Document language | | `--type` | `assessment`, `feature`, `analysis`, `process`, `custom` | `assessment` | Document type | | `--format` | `markdown`, `html`, `pdf` | `markdown` | Output format |

Document Types

| Type | Description | Use Case | |--------------|--------------------------------------|-------------------------------------------------------| | `assessment` | Evaluation and audit documents | Technical debt, security review, performance analysis | | `feature` | Feature specifications and proposals | New features, enhancements, requirements | | `analysis` | Deep-dive technical analysis | Gap analysis, impact analysis, comparative studies | | `process` | Process and workflow documentation | SOPs, runbooks, procedures | | `custom` | Custom document format | Any specific documentation need |

Languages

| Code | Language | Full Code | |------|------------|-----------| | `en` | English | `en-US` | | `it` | Italian | `it-IT` | | `es` | Spanish | `es-ES` | | `fr` | French | `fr-FR` | | `de` | German | `de-DE` | | `pt` | Portuguese | `pt-BR` |

Core Principles

• **Codebase-Driven**: Analyze actual code to generate accurate documentation
• **Multi-Language**: Full support for multiple languages with proper terminology
• **Structured Output**: Follow professional document templates and standards
• **Actionable Content**: Include concrete recommendations and next steps
• **Stakeholder-Ready**: Produce documents ready for review and distribution

---

Phase 1: Discovery

**Goal**: Understand what document needs to be generated

**Actions**:

1. Parse $ARGUMENTS to extract:

• `--lang` parameter (default: `en`)
• `--type` parameter (default: `assessment`)
• `--format` parameter (default: `markdown`)
• Remaining text as the document objective/description

2. Create todo list with all phases 3. ****[GATE]** MANDATORY STOP POINT**: If the document objective is unclear or underspecified, you MUST call the AskUserQuestion tool to ask the user:

• What is the purpose of this document?
• Who is the target audience?
• What specific areas should be covered?
• Any constraints or requirements?

4. ****[GATE]** STOP: Wait for the user's answers before proceeding. Do NOT proceed to Phase 2 until requirements are clear.** 5. Summarize understanding and confirm with user

---

Phase 2: Codebase Analysis

**Goal**: Gather relevant information from the codebase

**Actions**:

1. Use the Task tool to launch an explorer agent to analyze the codebase

**Agent Selection by Project Type**:

• Java/Spring Boot: `developer-kit:spring-boot-backend-development-expert`
• TypeScript/NestJS: `developer-kit:nestjs-backend-development-expert`
• TypeScript/General: `developer-kit:general-code-explorer`
• React: `developer-kit:react-frontend-development-expert`
• General: `developer-kit:general-code-explorer`

**Example Task Tool Usage**:

   Task(
     description: "Analyze codebase for document generation",
     prompt: "Analyze the codebase structure, architecture, patterns, and relevant details for generating a [document-type] document about [objective]. Return a comprehensive summary with file references.",
     subagent_type: "developer-kit:general-code-explorer"
   )

2. Based on document type, gather specific information:

**For Assessment Documents**:

• Code quality metrics
• Architecture patterns
• Securi