skills.rest
Kaspazza
KaspazzaCOMMUNITY
Explore all skills by this author →
GitHub

portfolio-quality-guide

Audit and document portfolio scenes and API references for ClojureScript/Reagent component libraries.

Updated Aug 25, 2024
Search Tags:#documentation#portfolio#api-reference#ui-components#clojurescript#reagent
One-click install
npx skills add https://github.com/Kaspazza/doom-config --skill portfolio-quality-guide
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: portfolio-quality-guide
Source: https://github.com/Kaspazza/doom-config/tree/main/eca/skills/portfolio-quality-guide
Command: npx skills add https://github.com/Kaspazza/doom-config --skill portfolio-quality-guide

SYSTEM DOCUMENTATION & REQUIREMENTS

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.

Frequently Asked Questions about portfolio-quality-guide

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

FAQPage Schema
How do I write API references for ClojureScript Reagent UI components?▼

To write API references for ClojureScript Reagent components, audit the source code against existing portfolio docs, then document component cards, prop definitions, and usage notes using a consistent scene structure.

What is the best way to document UI component library props and demos?▼

The best way to document UI component library props is following a four-phase workflow that audits source truth, writes API reference scenes, fills missing demo scenes, and cross-references related components to ensure consistency.

Does this documentation guide work with Portfolio defscene for Reagent libraries?▼

Yes, this guide specifically applies to ClojureScript and Reagent component libraries displayed via Portfolio, using defscene to structure component cards, demo scenes, and API references.

How do I audit existing portfolio documentation against my UI component source code?▼

To audit portfolio documentation, compare the source of truth against existing scenes to verify all public components and props are accurately documented, identify missing demos, and flag inconsistencies for correction.

Why document gotchas and accessibility considerations in UI component portfolio scenes?▼

Documenting gotchas, implicit behaviors, and accessibility considerations in portfolio scenes improves developer trust by exposing edge cases and design considerations that standard API references often miss.

Can I use this workflow to fill missing demo scenes for interactive UI components?▼

Yes, the workflow identifies and fills missing demo scenes for interactive components and layout documentation, ensuring all components have proper visual examples and accessibility considerations documented.

Related Skills

Explore More Design & Creative Skills→
daymadedaymade
1.3k

docs-cleaner

Consolidate redundant documentation files into a single source of truth.

Community
Advanced
coaguscoagus
2

technical-writer

Improve clarity, tone, and structure of php-api-builder developer documentation.

Community
Advanced
leocaseiroleocaseiro
2

write-storybook

Enforce the single-Playground pattern for React component stories in Storybook.

Community
Advanced
forwardimpactforwardimpact
4

libs-web-presentation

Convert Markdown to HTML and generate static documentation sites.

Official
Intermediate