sudocode

To convert source code into pseudocode, provide your code to generate a linear narrative preserving exact identifiers and behavior. This creates grepable flow docs, architecture specs, and documentation following canonical style rules.

Writing flow docs that preserve exact identifiers requires translating source code into a linear pseudocode narrative. This approach maintains traceability by keeping original variable names and function signatures intact during the code-to-pseudocode transformation.

Generating pseudocode from code preserves behavior-critical side effects and error paths to maintain fidelity. The transformation ensures that exception handling, state mutations, and control flow logic remain accurately represented in the resulting documentation.

You can inline short referenced logic when converting code to pseudocode to keep the narrative readable and compact. This inlining approach reduces documentation fragmentation by embedding concise helper implementations directly into the main flow.

Code-to-pseudocode transformation is applicable across languages and projects for generating architecture specs and documentation. The process focuses on translating behavioral logic and identifiers into a standardized pseudocode format regardless of the source language syntax.

You should avoid using pseudocode for documentation when your source code requires strict syntax validation or when visual structural representations like UML diagrams are needed instead of linear narrative text for architecture communication.