generate-project-documentation

Generate architecture, API reference, and developer guides for Go projects using Diátaxis and Mermaid.

37|4|Updated Apr 11, 2026
One-click install
npx skills add https://github.com/jmrplens/gitlab-mcp-server --skill generate-project-documentation-jmrplens
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: generate-project-documentation
Source: https://github.com/jmrplens/gitlab-mcp-server/tree/main/.github/skills/generate-project-documentation
Command: npx skills add https://github.com/jmrplens/gitlab-mcp-server --skill generate-project-documentation-jmrplens

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve? Keeping project documentation accurate and complete is hard: docs drift out of sync with source code, coverage is inconsistent, and structure varies between authors. This Skill analyzes an entire Go codebase and produces a complete, organized documentation suite with guaranteed parity to the source. ## Core Features & Use Cases - Full Documentation Suite Generation: Produces architecture overviews, package API references, MCP tools/resources/prompts references, onboarding guides, and configuration/deployment docs organized by the Diátaxis framework (Tutorials, How-to, Reference, Explanation). - Codebase Analysis Pipeline: Performs structured discovery of repository structure, architecture, API surface, and documentation gaps before writing anything, using a coverage matrix to prioritize critical documents. - Visual Architecture Diagrams: Generates Mermaid diagrams (C4 context, container, component, and sequence views) for architecture and data-flow documentation. - Use Case: A maintainer of a Go MCP server needs to onboard new contributors and publish reference docs; the Skill reads every Go source file, maps packages and tool registrations, and emits a cross-linked docs tree with no placeholders. ## Quick Start Ask the agent to generate complete project documentation for this repository following the Diátaxis framework with Mermaid architecture diagrams.

Frequently Asked Questions about generate-project-documentation

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I generate documentation for a Go project automatically?

Run the Skill against the repository root; it discovers the package structure, traces the entry point and request flow, inventories the API surface, then writes a complete docs tree. Every exported type and function is documented directly from source code.

What is the Diátaxis framework for documentation?

Diátaxis organizes documentation into four types: Tutorials, How-to guides, Reference, and Explanation. The Skill uses this structure to place each generated document, such as architecture explanations under concepts/ and configuration details under reference/.

Can it generate Mermaid diagrams for architecture docs?

Yes, the Skill requires at least one Mermaid diagram per architecture or package document. It produces C4 context, container, and component diagrams plus sequence diagrams tracing request flow from client to API.

Does it work with projects that have auto-generated documentation sections?

Yes, the Skill respects generator-owned content boundaries such as catalog tables and benchmark charts produced by code generators. It writes around those blocks and never edits them by hand, per the project's ADR conventions.

What are the limitations of automated documentation generation?

The Skill must read every source file to maintain parity, so very large repositories require substantial analysis time. It also depends on existing conventions like doc-ownership files and Makefile generators, which may not exist in other projects.