skills.rest
enchantednatures
enchantednaturesCOMMUNITY
Explore all skills by this author →
WebsiteGitHub

document

Generate README, API docs, and usage examples from code artifacts.

Updated May 7, 2025
Search Tags:#documentation#readme#api-docs#documentation-generation#usage-examples#inline-code-docs
One-click install
npx skills add https://github.com/enchantednatures/.dotfiles --skill document-enchantednatures
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: document
Source: https://github.com/enchantednatures/.dotfiles/tree/main/.config/opencode/skills/document
Command: npx skills add https://github.com/enchantednatures/.dotfiles --skill document-enchantednatures

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Manages and streamlines the creation of complete documentation for codebases and projects, turning code artifacts into clear, user-facing docs.

Core Features & Use Cases

  • Documentation generation: Produce README, API docs, usage examples, and inline code comments from code and design artifacts.
  • Handoff readiness: Prepare docs for onboarding, external integrations, and public APIs.
  • Compliance and quality: Ensure documentation meets project standards before release.

Quick Start

Create a documentation package from your existing project by running the documentation workflow to generate README, API references, and usage examples.

Frequently Asked Questions about document

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

FAQPage Schema
How do I auto-generate comprehensive project documentation from code?▼

Auto-generate project documentation by running a multi-phase workflow that inventories code and design artifacts, writes content, and reviews output to produce READMEs, API docs, and usage examples.

What is the best way to prepare codebase documentation for onboarding and API handoffs?▼

Prepare codebase documentation for API handoffs by processing code artifacts through a structured workflow that generates README files, API references, and inline code comments to ensure integration readiness.

Can I generate inline code documentation and usage examples from existing artifacts?▼

Generate inline code documentation and usage examples from existing code and design artifacts by applying a structured documentation workflow that extracts metadata using YAML frontmatter and operational instructions in Markdown.

Does the documentation generation workflow support a multi-phase review process?▼

The documentation generation workflow supports a multi-phase review process consisting of artifact inventory, content writing, and review phases to ensure documentation meets project compliance and quality standards.

When do I need to use YAML frontmatter and Markdown for documentation generation?▼

Use YAML frontmatter for metadata and Markdown for operational instructions when generating documentation to structure README files and API references properly during the post-implementation handoff process.

Related Skills

Explore More Content & Communication Skills→
atlanhqatlanhq
26

incremental-migrate

Analyze connector codebases and generate incremental extraction components for Atlan applications.

Official
Advanced
Renzo-TognellaRenzo-Tognella

documentation

Generate and maintain technical documentation for Ruby on Rails applications.

Community
Advanced
lehuuhau1231lehuuhau1231

lint-and-validate

Run linting and type checking across multiple programming ecosystems.

Community
Intermediate
JongsixJongsix

moai-docs-generation

Generate technical documentation from source code and API definitions.

Community
Advanced