josephkkmok

markdown-flowchart-creator

Create Markdown flowcharts with ASCII diagrams, decision trees, color-coded sections, and detailed explanations. Use when users request markdown flowcharts, ASCII diagrams, process documentation, workflow visualizations, or decision trees in markdown format.

josephkkmok 0 Updated 4mo ago
GitHub

Install

npx skillscat add josephkkmok/markdown-flowchart-creator

Install via the SkillsCat registry.

SKILL.md

Markdown Flowchart Creator

Overview

Create comprehensive Markdown flowcharts with ASCII diagrams, detailed explanations, and real-world examples. This skill produces documentation-style flowcharts that combine visual flow diagrams with contextual information.

When to Apply

Reference this skill when:

  • User requests "Create a flowchart in markdown for [process]"
  • User asks to "Generate a flow diagram as markdown"
  • User wants to "Make an ASCII flowchart for [workflow]"
  • User needs to "Document the flow of [system/process]"
  • User says "Show me how [process] works in markdown"

Key Characteristics

This skill creates documentation-style flowcharts that combine:

  1. ASCII diagrams for visual flow
  2. Detailed explanations of each path
  3. Real-world examples
  4. Configuration details
  5. Benefits and trade-offs
  6. Maintenance commands (when applicable)

Quick Reference

Document Structure Template

# ๐Ÿ”’ [Process Name] Flow Diagram

[Brief description]

---

## Flow Overview

[ASCII diagram showing the main flow]

---

## ๐ŸŸข [Path 1 Name]

[Description of when this path is taken]

### Examples:
- Example 1
- Example 2

---

## ๐Ÿ”ต [Path 2 Name]

[Description of when this path is taken]

### Examples:
- Example 1
- Example 2

---

## โš™๏ธ Configuration Summary

[Relevant configuration, environment variables, etc.]

---

## ๐Ÿ“Š Flow Examples

### Example 1: [Scenario Name]
[Step-by-step flow for this scenario]

---

## ๐ŸŽฏ Benefits

[Benefits of different paths/approaches]

---

## ๐Ÿ› ๏ธ Maintenance Commands

[Relevant commands for managing the system]

---

## ๐Ÿ“ Notes

[Important notes and caveats]

ASCII Diagram Patterns

Basic Linear Flow

โ”Œโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”
โ”‚   Start Node    โ”‚
โ””โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”ฌโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”˜
         โ”‚
         โ–ผ
โ”Œโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”
โ”‚  Process Step   โ”‚
โ””โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”ฌโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”˜
         โ”‚
         โ–ผ
โ”Œโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”
โ”‚   End Node      โ”‚
โ””โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”˜

Decision Point (Binary)

         โ”‚
         โ–ผ
โ•”โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•—
โ•‘   Decision?    โ•‘
โ•šโ•โ•โ•โ•โ•โ•โ•โ•ฆโ•โ•โ•โ•โ•โ•โ•โ•โ•
        โ”‚
    โ”Œโ”€โ”€โ”€โ”ดโ”€โ”€โ”€โ”
    โ”‚       โ”‚
  YES       NO
    โ”‚       โ”‚
    โ–ผ       โ–ผ
โ”Œโ”€โ”€โ”€โ”€โ”€โ”€โ” โ”Œโ”€โ”€โ”€โ”€โ”€โ”€โ”
โ”‚ Path โ”‚ โ”‚ Path โ”‚
โ”‚  A   โ”‚ โ”‚  B   โ”‚
โ””โ”€โ”€โ”€โ”€โ”€โ”€โ”˜ โ””โ”€โ”€โ”€โ”€โ”€โ”€โ”˜

Decision Point (Multi-path)

         โ”‚
         โ–ผ
โ•”โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•—
โ•‘   Decision?    โ•‘
โ•šโ•โ•โ•โ•โ•โ•โ•โ•ฆโ•โ•โ•โ•โ•โ•โ•โ•โ•
        โ”‚
    โ”Œโ”€โ”€โ”€โ”ผโ”€โ”€โ”€โ”
    โ”‚   โ”‚   โ”‚
   A    B   C
    โ”‚   โ”‚   โ”‚
    โ–ผ   โ–ผ   โ–ผ

Parallel Paths

        โ”‚
        โ–ผ
โ”Œโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”
โ”‚ Starting Pointโ”‚
โ””โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”ฌโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”˜
        โ”‚
    โ”Œโ”€โ”€โ”€โ”ดโ”€โ”€โ”€โ”
    โ”‚       โ”‚
    โ–ผ       โ–ผ
โ”Œโ”€โ”€โ”€โ”€โ”€โ”€โ” โ”Œโ”€โ”€โ”€โ”€โ”€โ”€โ”
โ”‚Path Aโ”‚ โ”‚Path Bโ”‚
โ””โ”€โ”€โ”€โ”ฌโ”€โ”€โ”˜ โ””โ”€โ”€โ”ฌโ”€โ”€โ”€โ”˜
    โ”‚       โ”‚
    โ””โ”€โ”€โ”€โ”ฌโ”€โ”€โ”€โ”˜
        โ–ผ

Cycle/Loop

โ”Œโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”
โ”‚   Start Loop    โ”‚
โ””โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”ฌโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”˜
         โ”‚
         โ–ผ
    โ•”โ•โ•โ•โ•โ•โ•โ•โ•โ•—
    โ•‘Continueโ•‘ โ”€โ”€NOโ”€โ”€โ”
    โ•šโ•โ•โ•โ•ฆโ•โ•โ•โ•โ•       โ”‚
        โ”‚            โ”‚
       YES           โ”‚
        โ”‚            โ”‚
        โ–ผ            โ–ผ
โ”Œโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ” โ”Œโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”
โ”‚ Loop Action โ”‚ โ”‚  Exit  โ”‚
โ””โ”€โ”€โ”€โ”€โ”€โ”€โ”ฌโ”€โ”€โ”€โ”€โ”€โ”€โ”˜ โ””โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”˜
       โ”‚
       โ””โ”€โ”€โ”€โ”€โ”€โ”€โ”
              โ”‚
              โ–ผ
        [back to top]

Complex Multi-Stage Flow

โ”Œโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”
โ”‚                       Starting Point                         โ”‚
โ””โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”ฌโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”˜
                               โ”‚
                               โ–ผ
                  โ•”โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•—
                  โ•‘      Decision 1?       โ•‘
                  โ•šโ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•ฆโ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•
                              โ”‚
              โ”Œโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”ดโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”
              โ”‚                               โ”‚
          โœ… YES                          โŒ NO
              โ”‚                               โ”‚
              โ–ผ                               โ–ผ
  โ”Œโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”      โ”Œโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”
  โ”‚   Path A Process      โ”‚      โ”‚   Path B Process         โ”‚
  โ””โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”ฌโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”˜      โ””โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”ฌโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”˜
              โ”‚                               โ”‚
              โ”‚                               โ–ผ
              โ”‚                   โ•”โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•—
              โ”‚                   โ•‘    Sub-Decision?       โ•‘
              โ”‚                   โ•šโ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•ฆโ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•
              โ”‚                               โ”‚
              โ”‚                    โ”Œโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”ดโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”
              โ”‚                    โ”‚                     โ”‚
              โ”‚                  YES                    NO
              โ”‚                    โ”‚                     โ”‚
              โ–ผ                    โ–ผ                     โ–ผ
  โ”Œโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”  โ”Œโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”         โ”Œโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”
  โ”‚ โœ“ Final Destination   โ”‚  โ”‚ Result1 โ”‚         โ”‚ Result2 โ”‚
  โ””โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”˜  โ””โ”€โ”€โ”€โ”€โ”ฌโ”€โ”€โ”€โ”€โ”˜         โ””โ”€โ”€โ”€โ”€โ”ฌโ”€โ”€โ”€โ”€โ”˜
                                  โ”‚                    โ”‚
                                  โ””โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”ฌโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”˜
                                           โ–ผ
                                  โ”Œโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”
                                  โ”‚ Final Outcome  โ”‚
                                  โ””โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”˜

Character Guide

Box Characters

โ”Œโ”€โ”  โ””โ”€โ”˜  โ”œโ”€โ”ค  โ”ฌโ”€โ”ด  โ”‚  โ”€
โ•”โ•โ•—  โ•šโ•โ•  โ• โ•โ•ฃ  โ•ฆโ•โ•ฉ  โ•‘  โ•

Arrows

โ†’  โ†  โ†‘  โ†“  โ–ฒ  โ–ผ  โ–ถ  โ—€

Connectors

โ”Œ  โ”  โ””  โ”˜  โ”œ  โ”ค  โ”ฌ  โ”ด  โ”ผ
โ•”  โ•—  โ•š  โ•  โ•   โ•ฃ  โ•ฆ  โ•ฉ  โ•ฌ

Emojis for Sections

Use emojis to make sections visually distinct:

  • ๐Ÿ”’ Security/Authentication
  • ๐ŸŸข Success/Direct path
  • ๐Ÿ”ต Alternative path
  • ๐Ÿ”ด Error/Failure path
  • ๐ŸŸก Warning/Caution
  • ๐ŸŸ  Internal/System
  • โš™๏ธ Configuration
  • ๐Ÿ“Š Examples/Data
  • ๐ŸŽฏ Benefits/Goals
  • ๐Ÿ› ๏ธ Maintenance/Tools
  • ๐Ÿ“ Notes/Documentation
  • ๐Ÿ”„ Retry/Loop
  • โœ… Yes/Success
  • โŒ No/Failure
  • ๐Ÿ“ฆ Package/Module
  • ๐ŸŒ Network/Internet
  • ๐Ÿ”— Connection/Link
  • ๐Ÿ“น Camera/Media
  • ๐Ÿš€ Performance/Speed
  • โšก Fast/Quick
  • ๐Ÿ’ฐ Cost/Savings

Section Templates

Configuration Section

## โš™๏ธ Configuration Summary

### Environment Variables (file.yml)

\`\`\`yaml
environment:
  VAR_NAME: value
  ANOTHER_VAR: value
\`\`\`

### Component Settings

#### Component 1
- **Setting**: value
- **Function**: description
- **Config**: path/to/config

Examples Section

## ๐Ÿ“Š Flow Examples

### Example 1: [Scenario Name]
\`\`\`
Step 1 โ†’ Action 1 โ†’ Check condition โ†’ โœ… MATCH
โ†’ Path A โ†’ Result
\`\`\`

### Example 2: [Scenario Name]
\`\`\`
Step 1 โ†’ Action 1 โ†’ Check condition โ†’ โŒ NO MATCH
โ†’ Path B โ†’ Fallback โ†’ Result
\`\`\`

Benefits Section

## ๐ŸŽฏ Benefits

### Path A Benefits
- โšก **Performance**: Description
- ๐Ÿ”ง **Simplicity**: Description
- ๐Ÿ’ฐ **Cost**: Description

### Path B Benefits
- ๐Ÿ”’ **Security**: Description
- ๐ŸŒ **Access**: Description
- ๐ŸŽญ **Privacy**: Description

Maintenance Commands

## ๐Ÿ› ๏ธ Maintenance Commands

### Command Category 1
\`\`\`bash
command --with-flags
\`\`\`

### Command Category 2
\`\`\`bash
another-command --option
\`\`\`

### View Logs
\`\`\`bash
tail -f /path/to/log
\`\`\`

Content Guidelines

  1. Start with Overview: Always begin with a high-level ASCII diagram showing the complete flow
  2. Use Color Coding: Use emoji circles (๐ŸŸข๐Ÿ”ต๐Ÿ”ด๐ŸŸ ) to categorize different paths
  3. Provide Context: Explain WHY each path exists, not just WHAT it does
  4. Include Examples: Show 3-5 real-world scenarios walking through the flow
  5. Add Configuration: Include relevant config files, environment variables, or settings
  6. List Benefits: Explain the trade-offs and benefits of different paths
  7. Maintenance Info: Add commands for monitoring, debugging, and managing the system
  8. Notes Section: Include important caveats, edge cases, or gotchas

File Naming

Save as: [TOPIC]-FLOW.md or [PROCESS]-DIAGRAM.md

Examples:

  • AUTHENTICATION-FLOW.md
  • DATA-PIPELINE-DIAGRAM.md
  • DEPLOYMENT-FLOW.md

Example Prompts

Good prompts:

  • "Create a markdown flowchart for our authentication process"
  • "Document the database migration flow in markdown"
  • "Show how requests are routed in our API gateway as a markdown diagram"
  • "Create an ASCII flowchart explaining the CI/CD pipeline"

What to deliver:

  1. Complete markdown file with ASCII diagrams
  2. Detailed explanations for each decision point
  3. Real-world examples showing different paths
  4. Configuration details relevant to the flow
  5. Benefits and trade-offs
  6. Maintenance commands when applicable

Tips

  • Keep diagrams readable: Don't make ASCII diagrams too wide (max 80-100 chars)
  • Use whitespace: Add blank lines between diagram sections for clarity
  • Label everything: Every arrow, decision, and path should be labeled
  • Be consistent: Use the same box style throughout the document
  • Add context: A diagram alone isn't enough - explain the "why" behind each step
  • Use code blocks: Wrap ASCII diagrams in triple backticks for proper formatting
  • Test rendering: Make sure the diagram looks good in both GitHub and text editors