portfolio-quality-guide

Community

Craft precise portfolio docs for UI libraries.

AuthorKaspazza
Version1.0.0
Installs0

System Documentation

What problem does it solve?

This Guide provides a structured methodology for analyzing and creating high-quality portfolio scenes and API references for UI component libraries, ensuring clear consumer-facing documentation.

Core Features & Use Cases

  • Audit source of truth against existing portfolio documentation to ensure all public components and their props are accurately documented.
  • Write API reference scenes with a consistent structure, including component cards, prop definitions, and usage notes.
  • Identify and fill missing demo scenes for interactive components and layout documentation, including accessibility considerations.
  • Cross-reference related components to avoid duplication and maintain consistency across the portfolio docs.
  • Document common gotchas, implicit behaviors, and design considerations to improve developer trust.

Quick Start

Follow Phase 1 through Phase 4 workflow to audit, document, and validate portfolio scenes and API references for a UI component library.

Dependency Matrix

Required Modules

None required

Components

Standard package

💻 Claude Code Installation

Recommended: Let Claude install automatically. Simply copy and paste the text below to Claude Code.

Please help me install this Skill:
Name: portfolio-quality-guide
Download link: https://github.com/Kaspazza/doom-config/archive/main.zip#portfolio-quality-guide

Please download this .zip file, extract it, and install it in the .claude/skills/ directory.
View Source Repository

Agent Skills Search Helper

Install a tiny helper to your Agent, search and equip skill from 471,000+ vetted skills library on demand.