docs-plugin

Standardize plugin documentation with required YAML frontmatter and structured sections.

16.5k|995|Updated Dec 2, 2019
One-click install
npx skills add https://github.com/udecode/plate --skill docs-plugin
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: docs-plugin
Source: https://github.com/udecode/plate/tree/main/.agents/skills/docs-plugin
Command: npx skills add https://github.com/udecode/plate --skill docs-plugin

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Creates and enforces a consistent, high-quality standard for plugin documentation, ensuring clarity, structure, and alignment with project conventions.

Core Features & Use Cases

  • Guided Documentation Structure: Defines required sections (Kit Usage, Manual Usage, API, Transforms) and formatting rules to maintain uniformity across all plugin docs.
  • Frontmatter & Linking Standards: Specifies mandatory YAML frontmatter fields and encourages precise, actionable linking to related docs and components.
  • Editorial Consistency: Provides style and formatting guidelines to ensure tone, brevity, and technical accuracy across authoring teams.

Quick Start

Consult the project guidelines to write new plugin documentation following the kit and manual usage patterns.

Frequently Asked Questions about docs-plugin

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

FAQPage Schema
How do I standardize plugin documentation structure across multiple projects?

Standardizing plugin documentation requires defining mandatory YAML frontmatter fields and structural sections. This enforces consistent tone, formatting, and technical accuracy across all authoring teams.

What YAML frontmatter fields are required for plugin documentation guidelines?

Mandatory YAML frontmatter fields are specified to maintain uniformity across plugin docs. They enforce metadata consistency and alignment with project conventions for all authored guides.

How do I write API reference and transforms sections for a plugin guide?

To write API and transforms sections, source content directly from code and existing docs. The guidelines provide formatting rules to maintain technical accuracy and brevity across these sections.

What is the best way to maintain editorial consistency in markdown documentation?

Maintaining editorial consistency in markdown documentation requires applying standardized style and formatting guidelines. This ensures uniform tone, brevity, and technical accuracy across authoring teams.

Does this documentation plugin standard work without external dependencies?

Yes, the documentation plugin standard operates without external dependencies. It independently applies structural rules and formatting guidelines to source content from code and existing docs.