skills.rest
henrybravo
henrybravoCOMMUNITY
Explore all skills by this author →
WebsiteGitHub

documentation-synthesis

Generate Markdown documentation from code comments and OpenAPI or GraphQL schemas.

Updated Dec 30, 2025
Search Tags:#architecture#documentation#markdown#onboarding#code-analysis#api-docs#readme-generation
One-click install
npx skills add https://github.com/henrybravo/developer-readiness-portal --skill documentation-synthesis
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: documentation-synthesis
Source: https://github.com/henrybravo/developer-readiness-portal/tree/main/.github/skills/documentation-synthesis
Command: npx skills add https://github.com/henrybravo/developer-readiness-portal --skill documentation-synthesis

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Automatically generates comprehensive documentation from code and specifications, reducing manual writing and accelerating onboarding for developers, product teams, and stakeholders.

Core Features & Use Cases

  • API Documentation: Generate endpoint references, schemas, and usage examples from OpenAPI/GraphQL specs and code.
  • Architecture Documentation: Produce system overviews, component mappings, and data flows from codebase analyses.
  • User Guides & READMEs: Create getting-started guides, configuration notes, and README documents from project artifacts.

Quick Start

Provide a repository or project artifacts and request synthesized documentation for APIs, architecture, and guides.

Frequently Asked Questions about documentation-synthesis

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

FAQPage Schema
How do I generate API documentation from OpenAPI or GraphQL schemas?▼

You can generate API documentation by providing OpenAPI or GraphQL schemas and code as input. The system extracts endpoint references, schemas, and usage examples to produce structured Markdown output.

What's the best way to create a README from code and PRD specifications?▼

Creating a README from code and PRD specifications involves extracting project artifacts like configuration notes and getting-started guides. The system synthesizes these inputs into structured Markdown documentation automatically.

Can I produce architecture diagrams and system overviews from a codebase analysis?▼

Architecture documentation can be produced by analyzing your codebase to extract system overviews, component mappings, and data flows. The output is structured Markdown detailing your software architecture.

Does this documentation generation approach work with existing code comments and ADR files?▼

Documentation generation works with existing code comments, ADR files, and specifications like PRDs or FRDs. It extracts information from these sources to accelerate onboarding and reduce manual writing across software projects.

What format does the synthesized documentation output use?▼

Synthesized documentation outputs use Markdown format with templates and style guidance. This structured output applies to API references, architecture maps, and user guides across your software projects.

Related Skills

Explore More Content & Communication Skills→
ChenYCLChenYCL

api-docs

Generate API documentation and OpenAPI 3.0 specs from code or descriptions.

Community
Intermediate
JongsixJongsix

moai-docs-generation

Generate technical documentation from source code and API definitions.

Community
Advanced
NabilThangeNabilThange
1

lint-and-validate

Automate linting and static analysis for Node.js, Python, and TypeScript code.

Community
Intermediate
pelcherspelchers

creating-project-documentation

Generate Markdown project documentation from repository structure and metadata.

Community
Intermediate