create-documentation

Generate Markdown documentation drafts from source code following WRITING_STYLE guidelines.

1.8k|62|Updated Jan 11, 2026
One-click install
npx skills add https://github.com/LibPDF-js/core --skill create-documentation
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: create-documentation
Source: https://github.com/LibPDF-js/core/tree/main/.opencode/skills/create-documentation
Command: npx skills add https://github.com/LibPDF-js/core --skill create-documentation

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill helps teams produce consistent, high-quality Markdown documentation for library modules or features by analyzing code, applying WRITING_STYLE guidelines, and generating ready-to-publish docs.

Core Features & Use Cases

  • Automated API documentation: Generate Markdown docs that summarize public APIs, behaviors, and usage patterns.
  • Structure-enforced docs: Adheres to the project's documentation structure and WRITING_STYLE guidelines.
  • Use Case: Document a new module by converting its public API and examples into a complete documentation page ready for MDX.

Quick Start

Identify the module to document, read its source code, and generate a comprehensive Markdown documentation draft following the WRITING_STYLE guidelines. Then review and publish.

Frequently Asked Questions about create-documentation

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

FAQPage Schema
How do I generate Markdown documentation from source code automatically?

To generate Markdown documentation from source code, analyze the module's public API and usage patterns, then apply WRITING_STYLE guidelines to produce a ready-to-publish draft. This ensures consistent API docs and usage examples across your project.

What is the best way to create MDX-ready API docs for a library module?

Creating MDX-ready API docs involves analyzing source code to extract public APIs and behaviors, then formatting them into Markdown that adheres to your project's WRITING_STYLE.md. This produces a structured documentation page ready for review and publishing.

Can I enforce a custom writing style when generating module documentation?

Yes, you can enforce a custom writing style by adhering to WRITING_STYLE.md guidelines during content generation. The documentation process analyzes source code and strictly applies these defined style rules to the Markdown output.

Do I need a WRITING_STYLE.md file to document a new module?

A WRITING_STYLE.md file is required to ensure structure-enforced documentation. The generation process reads this file to apply consistent formatting and structural guidelines to the module's Markdown documentation draft.

How does automated documentation handle usage examples for APIs?

Automated documentation handles usage examples by analyzing the source code to identify usage patterns, then converting those API behaviors and examples into a comprehensive Markdown documentation page ready for MDX publishing.