skills.rest
ArtisanCloud
ArtisanCloudOFFICIAL
Explore all skills by this author →
GitHub

feature-guide

Generate executable PowerX feature guides with Mermaid diagrams and code mappings.

357|65|Updated Jul 29, 2022
Search Tags:#documentation#mermaid#runbook#code-mapping#powerx#feature-guide
One-click install
npx skills add https://github.com/ArtisanCloud/PowerX --skill feature-guide
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: feature-guide
Source: https://github.com/ArtisanCloud/PowerX/tree/main/.codex/skills/docs/feature-guide
Command: npx skills add https://github.com/ArtisanCloud/PowerX --skill feature-guide

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

PowerX features often lack executable, cross-role documentation that ties UI pages, Admin/Tenant APIs, backend handlers, and observability into a single, verifiable workflow. This Skill eliminates ambiguity by producing structured, actionable guides that include diagrams, acceptance criteria, rollback plans, and direct code mappings so teams can operate, test, and troubleshoot features without guesswork.

Core Features & Use Cases

  • Enforces a mandatory document structure covering background, roles, module relationships, core flows, swimlanes, preconditions, step-by-step page/API/command procedures, acceptance criteria, troubleshooting, rollback, and change logs.
  • Generates required Mermaid flowcharts and simulated swimlane diagrams, links operational steps to code locations (routes/handlers/services/tests), and decides output paths for deploy vs feature guides.
  • Ideal for new feature launches, release handover, QA verification, and ops runbooks where Web Admin interactions, Admin/Tenant APIs, and backend behavior must be verifiable and reproducible.

Quick Start

Use the feature-guide skill to generate a complete, executable guide from specs/025-powerx-docker-systemd and write it to docs/guides/deploy/025-powerx-docker-systemd/guide.md.

Frequently Asked Questions about feature-guide

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

FAQPage Schema
How do I generate executable feature runbooks that link PowerX UI pages and Admin APIs?▼

Executable feature runbooks are generated by converting specs and code into role-specific operational documentation. This process links Web Admin pages, Admin/Tenant APIs, and backend handlers with mermaid diagrams and acceptance criteria.

What is the best way to create cross-role operational documentation for a PowerX feature release?▼

Cross-role operational documentation is created by enforcing structured sections that cover core flows, preconditions, and step-by-step procedures. This ensures QA verification and operational handover scenarios are verifiable and reproducible.

How do I map backend code locations to operational steps in a release handover guide?▼

Mapping backend code locations to operational steps is done by linking routes, handlers, services, and tests directly within the documentation. This provides direct code-to-document mappings for troubleshooting and verification.

Does the feature guide generation process include rollback steps and acceptance criteria?▼

Rollback steps and acceptance criteria are mandatory sections enforced within the generated guide structure. This ensures teams can operate, test, and troubleshoot features while having clear recovery plans.

Can I use mermaid diagrams to visualize module relationships and swimlanes for PowerX features?▼

Mermaid diagrams are required to visualize module relationships and simulated swimlanes for PowerX features. These diagrams are generated automatically to provide clear core flow visualization.

When do I need to output feature guides to different deploy and feature category paths?▼

Output paths for deploy and feature categories are decided automatically based on the feature type. This routing ensures documentation is organized correctly for new feature launches and ops runbooks.

Related Skills

Explore More Software Engineering Skills→
ArtisanCloudArtisanCloud
357

crud-http

Validate PowerX CRUD HTTP implementations for multi-tenant compliance and standardized routing.

Official
Intermediate
paycruxpaycrux

qa-guide

Generate a structured QA test guide from task-plan documents.

Official
Intermediate
htayjhtayj

add-rest-endpoint

Automate REST API endpoint creation with schema design, routing, handlers, tests, and documentation.

Community
Intermediate
cxnaivecxnaive

code-wiki

Generates structured wiki documentation and Mermaid diagrams for software repositories.

Community
Advanced