docs-standards

Maintain SDD plugin documentation with frontmatter-driven metadata and markdown structure.

39|3|Updated Nov 21, 2025
One-click install
npx skills add https://github.com/LiorCohen/sdd --skill docs-standards-liorcohen
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: docs-standards
Source: https://github.com/LiorCohen/sdd/tree/main/.claude/skills/docs-standards
Command: npx skills add https://github.com/LiorCohen/sdd --skill docs-standards-liorcohen

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Writes and maintains user-facing documentation for the SDD plugin, proactively detecting when docs are out of sync with plugin capabilities.

Core Features & Use Cases

  • Maintains README and docs/ with up-to-date guidance, tutorials, and references.
  • Enforces a consistent documentation structure that matches plugin capabilities.
  • Supports audits to identify and fix documentation gaps.

Quick Start

Open the README and follow the getting-started guide to begin using the SDD plugin.

Frequently Asked Questions about docs-standards

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

FAQPage Schema
How do I keep user-facing documentation in sync with plugin capabilities?

To keep user-facing documentation in sync, you enforce a markdown structure with standardized frontmatter metadata, enabling proactive detection of gaps when plugin capabilities change.

What is frontmatter-driven discovery for documentation?

Frontmatter-driven discovery uses a standardized metadata schema enforcing keywords, category, and description within markdown files to maintain consistent documentation structure and searchability.

How do I audit existing docs to find capability gaps?

You audit existing docs by comparing standardized frontmatter metadata against current plugin capabilities, identifying mismatches in the markdown structure, and fixing the missing user guides.

Can I maintain README and docs folders using a standardized metadata schema?

Yes, you can maintain README and docs folders by applying a standardized metadata schema with frontmatter, ensuring all tutorials and references match current plugin capabilities.

Why does documentation go out of sync after plugin updates?

Documentation goes out of sync after updates when the markdown structure lacks enforced metadata standards, preventing proactive detection of new or deprecated plugin capabilities.

Does docs-standards work without external dependencies?

Yes, docs-standards operates without external dependencies, relying entirely on frontmatter-driven markdown structures to enforce documentation standards and audit capabilities.