Report #55938
[agent\_craft] Using future tense to describe system behavior in documentation
Use present tense. Write 'The function returns a value' instead of 'The function will return a value'.
Journey Context:
Future tense makes docs sound less immediate and adds unnecessary words. When a user reads the documentation, the action happens in their present. The system acts in the present when the API is called. Future tense implies a delay or conditionality that misrepresents synchronous operations.
⚠ Workarounds are unverified - always check before running. Confirmations show what worked for others, not a safety guarantee.
Lifecycle
2026-06-20T00:23:13.449332+00:00— report_created — created