standard-output-formats

name	standard-output-formats
description	Reusable documentation components for technical writing. Use when structuring technical documentation, creating user guides, or needing consistent formatting patterns for explanations, comparisons, code examples, diagrams, and troubleshooting workflows.

Select and combine the output format components based on your documentation needs, audience, and goals:

• Read formats/technical-overview-format.md if you need to explain complex technical systems or implementations with multiple levels of detail. Provides structured technical explanation with progressive detail levels for different developer needs. Use when developers need both quick reference and detailed understanding.
• Read formats/visual-formatting-techniques.md if complex system relationships need visual clarification within narrative explanations. Demonstrates ASCII visual formatting and diagram techniques for enhancing narrative explanations with strategic visual elements. Use when process flows, architecture concepts, or data patterns need visual anchoring.
• Read formats/structured-comparison-tables-format.md if you need to compare multiple options, before/after states, or feature availability. Presents multiple options, states, or configurations in a scannable tabular format for easy decision-making. Use when evaluating solutions or showing configuration differences.
• Read formats/code-example-frameworks-format.md if you need to teach new APIs, show migration patterns, or demonstrate best practices vs anti-patterns. Demonstrates code implementation patterns with progressive complexity and clear annotations. Use when building from simple to complex examples or providing language-specific implementations.
• Read formats/ascii-diagrams-format.md if you need to explain system architecture, data flow, or process sequences visually. Visualizes system architecture, data flow, or process sequences using text-based diagrams. Use when creating diagrams that live with code in version control.
• Read formats/error-status-categorization-format.md if you need to document API error responses or create troubleshooting matrices. Organizes errors, statuses, or responses into structured categories with clear resolution paths. Use when mapping status codes to actions or building error recovery strategies.
• Read formats/phased-learning-structures-format.md if you're creating tutorials, learning paths, or onboarding documentation. Guides learners through progressive skill building with clear milestones and validation checkpoints. Use when structuring complex topics for gradual understanding or designing self-paced training materials.
• Read formats/system-status-format.md if you need to document current system operational status or component health states. Documents observable system states and component health without quantitative metrics. Use when describing system behavior patterns or creating operational runbooks.
• Read formats/quick-reference-sections-format.md if you need to provide cheat sheets, command references, or quick configuration templates. Provides rapid-lookup information optimized for copy-paste and immediate use. Use when users need quick command references or API endpoint summaries.
• Read formats/troubleshooting-workflows-format.md if you're creating incident response runbooks or debugging guides. Guides systematic problem diagnosis through structured investigation steps and decision trees. Use when documenting diagnostic procedures or reducing mean time to resolution (MTTR).
• Read formats/implementation-details-format.md if you need to define API contracts, data schemas, or detailed configuration specifications. Documents technical specifications, schemas, and detailed configurations with precision. Use when specifying validation rules or creating integration specifications.
• Read formats/supporting-resources-format.md if you need to provide escalation paths, support contacts, or additional learning resources. Provides organized links, references, and next steps to extend learning or get help. Use when concluding documentation or offering tools and utilities.
• Read formats/validation-checklist-format.md if you need to create implementation validation checklists or quality gates. Provides structured checklists for verifying technical implementation completeness and correctness. Use when documenting verification procedures or establishing quality standards.
• Read formats/user-guidance-elements-format.md if you need to set user expectations, prevent common mistakes, or provide contextual warnings. Provides contextual help, warnings, and best practices to guide users toward success. Use when highlighting important information or guiding decision-making.