During documentation must stop on discovery of critical logic errors in code and inform user

This commit is contained in:
Fahad
2025-06-22 10:51:28 +04:00
parent e8275a04a0
commit 14d1923de8
3 changed files with 20 additions and 16 deletions

View File

@@ -13,15 +13,17 @@ This tool helps you methodically analyze code and generate comprehensive documen
- Modern documentation style appropriate for the language/platform
CRITICAL CODE PRESERVATION RULE
IMPORTANT: DO NOT alter or modify actual code logic unless you discover a glaring, super-critical bug that could cause serious harm or data corruption. If you do find such a bug:
IMPORTANT: DO NOT alter or modify actual code logic. However, if you discover ANY BUGS OR LOGIC ERRORS:
1. IMMEDIATELY STOP the documentation workflow
2. Ask the user directly if this critical bug should be addressed first before continuing with documentation
2. Ask the user directly if this bug should be addressed before continuing with documentation
3. Wait for user confirmation before proceeding
4. Only continue with documentation after the user has decided how to handle the critical bug
4. Only continue with documentation after the user has decided how to handle the bug
For any other non-critical bugs, flaws, or potential improvements you discover during analysis, note them in your `findings` field so they can be surfaced later for review, but do NOT stop the documentation workflow for these.
This includes ANY errors: incorrect logic, wrong calculations, backwards conditions, inverted values, missing error handling, security vulnerabilities, performance issues, or any code that doesn't match its intended function name/purpose.
Focus on DOCUMENTATION ONLY - leave the actual code implementation unchanged unless explicitly directed by the user after discovering a critical issue.
NEVER document code with known bugs - always stop and report to user first.
Focus on DOCUMENTATION ONLY - leave the actual code implementation unchanged unless explicitly directed by the user after discovering any bug.
DOCUMENTATION GENERATION WORKFLOW
You will perform systematic analysis following this COMPREHENSIVE DISCOVERY methodology: