skills.rest
infiquetra
infiquetraOFFICIAL
Explore all skills by this author →
GitHub

generate-docs

Generate README, API specifications, and architecture diagrams for services.

8|Updated Nov 26, 2025
Search Tags:#developer tools#architecture#documentation#code generation#readme#api spec
One-click install
npx skills add https://github.com/infiquetra/infiquetra-claude-plugins --skill generate-docs-infiquetra
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: generate-docs
Source: https://github.com/infiquetra/infiquetra-claude-plugins/tree/main/plugins/docs-generator/skills/generate-docs
Command: npx skills add https://github.com/infiquetra/infiquetra-claude-plugins --skill generate-docs-infiquetra

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill requires pyyaml, and includes scripts (resource) components.

What problem does it solve?

This Skill automates the creation of essential documentation for services, saving developers significant time and ensuring consistency.

Core Features & Use Cases

  • Comprehensive Documentation: Generates READMEs, API specifications, and architecture diagrams.
  • Consistency: Ensures documentation adheres to defined templates and best practices.
  • Use Case: When launching a new microservice, use this Skill to automatically generate its initial README, OpenAPI spec, and a basic architecture diagram, allowing the team to focus on core development.

Quick Start

Use the generate-docs skill to create all documentation types for the 'wallet-service'.

Frequently Asked Questions about generate-docs

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

FAQPage Schema
How do I automate README and API spec generation for a new microservice?▼

Automate documentation generation by running Python scripts to create README.md files, API specifications, and architecture diagrams for a specified service name and output directory.

Can I generate only an architecture diagram instead of all documentation types?▼

Yes, documentation generation supports creating specific document types individually or generating all types at once for a given service name and output directory.

Do I need pyyaml installed to generate API specifications with this tool?▼

Yes, pyyaml is a required dependency for running the Python scripts that generate API specifications, architecture diagrams, and README files.

What is the best way to ensure consistent documentation across multiple services?▼

Use automated documentation generation scripts to enforce consistency by having READMEs, API specs, and architecture diagrams adhere to defined templates and best practices.

Does this documentation generator produce OpenAPI specs for Python services?▼

Yes, the tool generates API specifications, alongside README.md files and architecture diagrams, using Python scripts for your specified services.

Related Skills

Explore More Software Engineering Skills→
Fudan-SMI-labFudan-SMI-lab
39

torch-npu-pyyaml-preinstall

Preinstall PyYAML before torch-npu to prevent transitive dependency failures.

Official
Intermediate
JongsixJongsix

moai-docs-generation

Generate technical documentation from source code and API definitions.

Community
Advanced
M-Abdullah07M-Abdullah07
1

documentation-generation-doc-generate

Extract code metadata to generate OpenAPI specs, Mermaid diagrams, and developer guides.

Community
Advanced
stephanjstephanj
9

code-documenter

Generate docstrings, OpenAPI specs, and developer guides from source code.

Community
Advanced