develop-document

Convert stable ADRs into bilingual MDX docs with working demos.

12|2|Updated Nov 27, 2024
One-click install
npx skills add https://github.com/Pionpill/retikz --skill develop-document
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: develop-document
Source: https://github.com/Pionpill/retikz/tree/main/.agents/skills/develop-document
Command: npx skills add https://github.com/Pionpill/retikz --skill develop-document

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

It solves the problem of turning a feature that already passes implementation and test into complete documentation that users can discover, understand, and try via working demos on the docs site.

Core Features & Use Cases

  • Produce user-facing docs with demos first: Ensures the docs site demonstration is the primary deliverable, and that demos actually render the intended ADR behavior rather than placeholders.
  • Guide doc updates from code impact: Requires reading existing relevant pages under apps/docs/src/contents/** before deciding what to update, add, or omit for functional changes.
  • Enforce bilingual and API completeness: Validates zh/en MDX structure alignment, API table completeness, sidebar registration, and i18n key synchronization.

Quick Start

Use the develop-document skill to generate the complete stage-4 documentation plan and checklist for an ADR, then delegate the actual MDX/demo/API/sidebar/i18n outputs to the docs-doc-principle pipeline and doc-skill sub-splits.

Frequently Asked Questions about develop-document

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

FAQPage Schema
How do I convert a finished ADR into user-facing documentation with functioning demos?

To convert an ADR into user-facing documentation, validate impacted existing pages and enforce a checklist for API table rows, preview examples, and bilingual MDX alignment. This ensures the resulting demos render the intended behavior correctly under pnpm dev:docs.

What is the best way to generate bilingual MDX documentation for new API references?

Generating bilingual MDX documentation requires validating zh/en structural alignment and synchronizing i18n keys. You must complete the mandatory checklist covering API table rows, sidebar registration, and demo file naming to ensure full bilingual completeness.

How do I ensure my React demos run correctly on the docs site after adding new component props?

To ensure React demos run correctly after adding new component props, validate that all impacted existing pages under apps/docs/src/contents are updated. Enforce demo file naming conventions and confirm the demos execute properly under pnpm dev:docs.

Does updating documentation for changed component defaults require sidebar and i18n registration?

Updating documentation for changed defaults or semantics requires sidebar and i18n registration. You must validate impacted pages, add API table rows, align bilingual MDX structure, and synchronize i18n keys to maintain documentation completeness.

When do I need to validate existing docs pages before writing new MDX content?

You need to validate existing docs pages before writing new MDX content whenever an ADR introduces new IR fields, new components, or removed APIs. Reading relevant pages under apps/docs/src/contents first determines what to update, add, or omit for functional changes.

Can I use this approach to document removed APIs and changed semantics in a docs site?

Yes, you can document removed APIs and changed semantics by applying the red, yellow, and green documentation stages. This process validates impacted pages, enforces a mandatory checklist for API tables and demos, and ensures bilingual alignment for the docs site.