documentation-assistant

Generate repository documentation and publish it to Confluence.

Updated Aug 27, 2026

Search Tags:#documentation #technical writing #confluence #api documentation #readme generation #repo analysis

Ready to run

npx skills add https://github.com/diegouis/provectus-marketplace --skill documentation-assistant

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: documentation-assistant
Source: https://github.com/diegouis/provectus-marketplace/tree/main/plugins/proagent-documentation/skills/documentation-assistant
Command: npx skills add https://github.com/diegouis/provectus-marketplace --skill documentation-assistant

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This Skill streamlines the creation and management of technical documentation by automating the process of generating documents from code repositories and publishing them to Confluence.

Core Features & Use Cases

Automated Document Generation: Create READMEs, architecture diagrams, API references, onboarding guides, and runbooks directly from repository analysis.
Confluence Integration: Publish generated documentation to Confluence, ensuring content is up-to-date and accessible.
Repo Analysis: Scan repositories to understand structure, tech stack, and API endpoints for documentation purposes.
Use Case: Automatically generate and publish an API reference document for a new microservice to Confluence, ensuring developers have the latest information.

Quick Start

Use the documentation-assistant skill to generate a README file from the provided repository URL.

Frequently Asked Questions about documentation-assistant

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

FAQPage Schema

How do I automatically generate a README from a code repository?▼

You can generate a README from a code repository by using the documentation-assistant to scan the repo structure and tech stack to automatically create README content. It analyzes the codebase to understand its components and outputs a formatted README file.

Can I publish generated API documentation directly to Confluence?▼

Yes, you can publish generated API documentation directly to Confluence. The Skill supports Confluence page creation, updating, and content synchronization to ensure your API references remain accessible and up-to-date within your team's workspace.

What types of technical documentation can I create from repo analysis?▼

From repo analysis, you can create READMEs, architecture documents, API references, onboarding guides, and runbooks. The process works by scanning repositories to understand the structure, tech stack, and API endpoints for comprehensive technical writing.

Does the documentation generation work for microservices?▼

Yes, the documentation generation works for microservices and can automatically generate and publish an API reference document to Confluence. This ensures developers have the latest information for new microservices directly from the codebase analysis.

How do I keep Confluence documentation synchronized with my codebase?▼

You can keep Confluence documentation synchronized with your codebase using the content synchronization feature. It updates existing Confluence pages with newly generated documentation from your repository analysis to maintain consistency.

Do I need any dependencies to analyze repositories and generate architecture documents?▼

No dependencies are required to analyze repositories and generate architecture documents. The Skill operates independently to scan the codebase, understand the tech stack, and produce the technical writing output for your team.