markdown-flowchart-creator
1
总安装量
1
周安装量
#45725
全站排名
安装命令
npx skills add https://github.com/josephkkmok/markdown-flowchart-creator --skill markdown-flowchart-creator
Agent 安装分布
cursor
1
codex
1
claude-code
1
Skill 文档
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:
- ASCII diagrams for visual flow
- Detailed explanations of each path
- Real-world examples
- Configuration details
- Benefits and trade-offs
- 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
- Start with Overview: Always begin with a high-level ASCII diagram showing the complete flow
- Use Color Coding: Use emoji circles (ð¢ðµð´ð ) to categorize different paths
- Provide Context: Explain WHY each path exists, not just WHAT it does
- Include Examples: Show 3-5 real-world scenarios walking through the flow
- Add Configuration: Include relevant config files, environment variables, or settings
- List Benefits: Explain the trade-offs and benefits of different paths
- Maintenance Info: Add commands for monitoring, debugging, and managing the system
- Notes Section: Include important caveats, edge cases, or gotchas
File Naming
Save as: [TOPIC]-FLOW.md or [PROCESS]-DIAGRAM.md
Examples:
AUTHENTICATION-FLOW.mdDATA-PIPELINE-DIAGRAM.mdDEPLOYMENT-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:
- Complete markdown file with ASCII diagrams
- Detailed explanations for each decision point
- Real-world examples showing different paths
- Configuration details relevant to the flow
- Benefits and trade-offs
- 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