Resources Documentation Writer

Generate technical reference documentation for Medusa platform modules and integrations.

35.7k|5.0k|Updated Jan 18, 2020
One-click install
npx skills add https://github.com/medusajs/medusa --skill resources-documentation-writer
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: Resources Documentation Writer
Source: https://github.com/medusajs/medusa/tree/main/.claude/skills/resources-doc
Command: npx skills add https://github.com/medusajs/medusa --skill resources-documentation-writer

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill streamlines the creation of comprehensive reference documentation for the Medusa ecommerce platform, ensuring clarity and consistency for developers.

Core Features & Use Cases

  • Generates Documentation: Writes reference docs for modules, integrations, and tools.
  • Follows Patterns: Adheres to established documentation structures and Vale compliance.
  • Use Case: A developer needs to document a new custom payment gateway integration. They can use this Skill to generate the initial structure and content for the integration's documentation page, including installation and configuration steps.

Quick Start

Use the Resources Documentation Writer skill to write documentation for the new Stripe integration.

Frequently Asked Questions about Resources Documentation Writer

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

FAQPage Schema
How do I write reference documentation for a Medusa ecommerce module?

To write reference documentation for a Medusa ecommerce module, you can generate technical content for modules, integrations, and tools following established patterns and Vale compliance. This includes creating overview pages, feature pages, and integration guides with code examples and cross-project links.

What is the best way to document a custom payment gateway integration for Medusa?

The best way to document a custom payment gateway integration for Medusa is to generate the initial page structure and content automatically. This includes drafting installation steps, configuration instructions, and code examples specific to the integration.

Does the generated content follow Vale compliance for technical writing?

Yes, the generated content strictly follows Vale compliance for technical writing. The documentation adheres to established structural patterns to ensure clarity and consistency for developers reading the reference docs.

Can I generate developer guides with code examples for Medusa tools?

Yes, you can generate developer guides with code examples for Medusa tools. The process creates feature pages and integration guides that incorporate code examples and cross-project links to comprehensively explain platform functionality.

What types of documentation pages can I create for the Medusa platform?

You can create overview pages, feature pages, and integration guides for the Medusa platform. These pages support modules, integrations, and tools by providing structured technical references with code examples and cross-project links.