skills.rest
miyake-san
miyake-sanCOMMUNITY
Explore all skills by this author →
WebsiteGitHub

create-github-action-workflow-specification

Generate implementation-agnostic specifications for existing GitHub Actions CI/CD workflows.

Updated Aug 28, 2026
Search Tags:#workflow#devops#ci/cd#documentation#mermaid#specification#github actions
One-click install
npx skills add https://github.com/miyake-san/sogo-agent-platform --skill create-github-action-workflow-specification-miyake-san
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: create-github-action-workflow-specification
Source: https://github.com/miyake-san/sogo-agent-platform/tree/main/skills/core/create-github-action-workflow-specification
Command: npx skills add https://github.com/miyake-san/sogo-agent-platform --skill create-github-action-workflow-specification-miyake-san

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve? GitHub Actions workflows often lack formal documentation, making them hard to maintain, review, and evolve. This Skill analyzes an existing workflow file and produces a structured, implementation-agnostic specification that captures its behavior, requirements, and constraints in a format optimized for both humans and AI consumption. ## Core Features & Use Cases - Structured Specification Template: Generates a complete spec covering workflow overview, job dependencies, requirements matrices, input/output contracts, error handling, quality gates, and compliance controls. - Mermaid Execution Diagrams: Maps job flow and dependencies into visual diagrams, including parallel, conditional, and subgraph layouts for complex workflows. - AI-Optimized Output: Uses tables, concise language, and consistent terminology for token-efficient documentation. - Use Case: Point the Skill at your repository's deploy workflow file to produce a versioned spec document your DevOps team can review, update, and use as the source of truth before modifying the pipeline. ## Quick Start Ask the AI to create a formal specification for your GitHub Actions workflow file, for example by providing the path to your workflow YAML and requesting a CI/CD workflow specification document.

Frequently Asked Questions about create-github-action-workflow-specification

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

FAQPage Schema
How do I document an existing GitHub Actions workflow?▼

Provide the workflow YAML file and the Skill generates a structured specification covering purpose, triggers, job dependencies, inputs, outputs, and constraints. The output is saved as a Markdown spec file with Mermaid diagrams visualizing the execution flow.

What should a CI/CD workflow specification include?▼

A complete spec includes a workflow overview, execution flow diagram, jobs and dependencies table, functional and security requirements, input/output contracts, error handling strategy, quality gates, and change management process. This Skill's template covers all of these sections.

Can I generate Mermaid diagrams for GitHub Actions workflows?▼

Yes, the Skill maps job flow into Mermaid graph diagrams showing sequential, parallel, and conditional execution. For workflows with five or more jobs, it uses subgraphs to group phases like build and deploy.

Does the specification include implementation details of the workflow?▼

No, the specification is intentionally implementation-agnostic. It focuses on what the workflow accomplishes rather than specific syntax, commands, or tool versions, making it durable as the underlying implementation evolves.

When should I not use a workflow specification document?▼

A formal spec adds overhead for trivial or throwaway workflows with one or two jobs. It is most valuable for complex pipelines with multiple jobs, environments, quality gates, or compliance requirements that need review and change control.

Related Skills

Explore More Software Engineering Skills→
yaakaitoyaakaito
3

github-workflow

Create and edit GitHub Actions workflow YAML files for CI/CD pipelines.

Community
Advanced
badideal-2046badideal-2046
2

SpecVibe

Guide development through a seven-stage spec-first workflow from requirements to deployment.

Community
Advanced
EverClawEverClaw

ClawdStrike

Audit OpenClaw deployments for exposed interfaces, tool policies, secrets, and network posture.

Official
Advanced
fatihfatih
884

pr-comments

Fetch GitHub PR comments, review comments, and reviews for the current branch.

Community
Advanced