write-docs

Generate MCP-friendly documentation from custom element manifest data.

46|4|Updated May 27, 2025

Search Tags:#documentation #manifest #demos #generate #api-docs #custom-elements

Ready to run

npx skills add https://github.com/bennypowers/cem --skill write-docs-bennypowers

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: write-docs
Source: https://github.com/bennypowers/cem/tree/main/extensions/claude-code/skills/write-docs
Command: npx skills add https://github.com/bennypowers/cem --skill write-docs-bennypowers

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Manual component documentation is error-prone and hard to keep in sync with live manifests; this skill automates the generation of documentation from the element manifest data, ensuring accurate API details and usage guidance.

Core Features & Use Cases

Generate API references, attribute/slot/event lists, and demo guidance directly from the manifest
Produce usage examples and integration notes aligned with manifest descriptions
Update docs automatically when the manifest or source changes, reducing maintenance overhead

Quick Start

Generate a complete documentation page for a target element using its manifest data and guidelines.

Frequently Asked Questions about write-docs

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

FAQPage Schema

How do I generate API documentation from a custom elements manifest?▼

You can generate API documentation from a custom elements manifest by reading the manifest data to extract attributes, events, slots, and guidelines, then outputting structured documentation that aligns with MCP and LSP expectations.

What is the best way to keep element docs in sync with my live manifest?▼

Keeping element docs in sync with your live manifest is best achieved by automatically generating documentation directly from the manifest data, ensuring accurate API details and reducing manual maintenance overhead when source changes occur.

Can I produce usage examples and integration notes directly from manifest descriptions?▼

Yes, you can produce usage examples and integration notes directly from manifest descriptions by extracting the existing guidelines and API details to form comprehensive, MCP-friendly references for your custom elements.

Does auto-generated documentation work with MCP and LSP expectations?▼

Auto-generated documentation works with MCP and LSP expectations by reading element manifests and outputting structured documentation specifically aligned to meet the formatting and integration requirements of both protocols.

What custom element details can I extract for documentation from a manifest?▼

You can extract custom element attributes, events, slots, and guidelines from a manifest to build complete API references, demo guidance, and usage examples for your project components.

Why does manual component documentation become error-prone compared to manifest generation?▼

Manual component documentation becomes error-prone because it is hard to keep in sync with live manifests, whereas automating generation from manifest data ensures accurate API details and consistent usage guidance.