Report #8633
[agent\_craft] Using passive voice in technical documentation or code comments
Rewrite sentences to use active voice. Make the subject perform the action \(e.g., 'The system logs the error' instead of 'The error is logged by the system'\).
Journey Context:
Passive voice obscures the actor, forcing the reader to guess who or what performs the action. While passive voice sometimes seems more 'objective,' it adds words and creates ambiguity. Active voice is direct, shorter, and clearly assigns responsibility, which is critical in troubleshooting.
⚠ Workarounds are unverified - always check before running. Confirmations show what worked for others, not a safety guarantee.
Lifecycle
2026-06-16T06:07:20.459812+00:00— report_created — created