🎯

docs-out

🎯Skill

from toilahuongg/shopify-agents-kit

What it does

Generates comprehensive technical documentation by analyzing code, creating READMEs, ADRs, and guides with clarity and precision.

📦

Part of

toilahuongg/shopify-agents-kit(35 items)

docs-out

Installation

npm installInstall npm package

npm install -g shopify-cc-kit

npm installInstall npm package

npm install shopify-cc-kit

📖 Extracted from docs: toilahuongg/shopify-agents-kit

Need more details? View full documentation on GitHub →

1Installs

AddedFeb 4, 2026

View on GitHub Back to Skills

Skill Details

SKILL.md

Activates the Technical Writer to generate, update, or refactor internal project documentation. Use when creating READMEs, ADRs, or technical guides.

Overview

# Generate Documentation

Create or update internal technical documentation.

Scope and Strategy

- Identify the target for documentation (Specific file, directory, component, or decision).

- Determine the appropriate artifact type:

- README.md: For directories, components, or project root.

- ADR: For architectural decisions (Architecture Decision Record).

- Guide: For "How-to" or conceptual explanations.

- Confirm the placement of the documentation (e.g., co-located with code or in a docs/ folder).

Analysis and Context

- Read the relevant source code to ensure technical accuracy.

- Identify key concepts, architectural patterns, and "gotchas".

- Review existing related documentation to ensure consistency and avoid duplication.

Draft Documentation

- Generate the documentation content using the Technical Writer persona.

- Focus:

- Explain the Why and Structure, not just the How.

- Use active voice and clear, concise English.

- Include accurate code snippets with language tags.

- Use diagrams (Mermaid) if complex relationships exist.

Verification

- Validation:

- Are all commands copy-pasteable and working?

- Do relative links point to valid files?

- Is the tone consistent with internal developer documentation?

More from this repository10

🎯

shopify-polaris-icons🎯Skill

Provides comprehensive guidance and examples for integrating and using Shopify Polaris Icons in commerce applications with accessibility and semantic color tones.

🎯

shopify-polaris-viz🎯Skill

Generates accessible, Shopify Admin-styled data visualizations using Polaris Viz library for React applications.

🎯

shopify-polaris-design🎯Skill

Generates Shopify Polaris-styled React components and design elements for creating consistent and professional e-commerce interfaces.

🎯

threejs-loaders🎯Skill

Loads and manages 3D assets in Three.js, handling GLTF models, textures, and environments with comprehensive loading progress tracking.

🎯

brainstorm🎯Skill

Guides users through creative brainstorming by applying structured techniques like SCAMPER and Design Thinking to generate innovative solutions.

🎯

threejs-animation🎯Skill

Enables precise and flexible object animations in Three.js, supporting keyframe, skeletal, and procedural motion with advanced blending and playback control.

🎯

shopify-webhooks🎯Skill

Handles Shopify webhook verification, processing, and registration for real-time event synchronization with secure HMAC authentication.

🎯

shopify-extensions🎯Skill

Guides developers through building and integrating Shopify Extensions across Admin, Checkout, Theme, and Post-purchase interfaces using latest CLI and APIs.

🎯

design🎯Skill

Generates design-related tasks and recommendations for Shopify store aesthetics, layout, and visual branding using AI-powered analysis.

🎯

algorithmic-art🎯Skill

Generates algorithmic art philosophies and p5.js code sketches using computational aesthetics, seeded randomness, and generative design principles.