Deployer Training Materials Generator
Generate comprehensive, production-quality training documentation by scanning and analyzing a codebase using Gemini AI.
When to Use
- Creating onboarding documentation for new developers
- Generating deployer guides for operations teams
- Understanding a new or unfamiliar codebase
- Documenting a product before release
- EU AI Act Articles 13 & 14 compliance (Transparency & Human Oversight)
Quick Start
python scripts/generate_training.py --path /path/to/repo
Instructions
Identify the target codebase: Determine the repository root to scan.
Run the generator:
python "AI Act skills packages/AI Act package/deployer-training/scripts/generate_training.py" \ --path <path-to-repository> \ --name "Your Product Name"Review the output: Check project root
Output/Deployer_Guide.mdfor the generated documentation.Human review: Always recommend human review for accuracy and completeness.
What You Get
A comprehensive Deployer_Guide.md with:
- Executive Summary: High-level product overview.
- System Architecture: Component diagrams (Mermaid), data flow, tech stack.
- Product Capabilities: Core features, user journeys, configuration options.
- Developer Onboarding: Environment setup, extension patterns, testing guidelines.
- Operational Guide: Deployment strategy, troubleshooting & limitations.
Parameters
| Parameter | Type | Default | Description |
|---|---|---|---|
--path |
string | . |
Path to the repository root |
--output |
string | Deployer_Guide.md |
Output file path |
--model |
string | Auto | Specific model (uses gemini-3-pro-preview then gemini-2.0-flash-exp as fallback) |
Requirements
- Python 3.8+
google-genaipackage:pip install google-genaiGEMINI_API_KEYenvironment variable set
Best Practices
- Run on a clean checkout of the repository.
- The generator respects
.gitignoreand excludes.envfiles for security. - For large codebases, review the "Total context size" output to ensure it fits in the model's context window.
- Always perform human review on generated documentation.
EU AI Act Compliance
This tool addresses:
- Article 13: Transparency and provision of information to users
- Article 14: Human oversight requirements (documentation for deployers)
Converted and distributed by TomeVault — claim your Tome and manage your conversions.