process-documentation-with-flowcharts

What problem does it solve?

This Skill ensures that complex backend workflows are accurately documented using both high-level process flowcharts and detailed class-level code documentation, preventing knowledge silos and outdated information.

Core Features & Use Cases

• Mandatory Documentation Updates: Enforces that any change to workflow behavior requires corresponding updates to process documentation, Mermaid flowcharts, and code comments.
• Standardized Documentation Structure: Provides a clear template for process documentation, including purpose, entry points, detailed flow, domain rules, failure modes, key files, and tests.
• Use Case: When a new feature is added to the order processing system, this Skill guides the developer to update the OrderProcess documentation, including its Mermaid flowchart, and ensure the relevant job and action classes are clearly documented.

Quick Start

Update the documentation for the OrderProcess workflow, ensuring the Mermaid flowchart and key file lists are accurate.