Documentation Fiction Pattern

A Documentation Fiction Pattern is a documentation anti-pattern that represents commonly occurring false or imaginary documentation elements that waste developer time and erode trust.

• AKA: Documentation Lie Pattern, Documentation Ghost Pattern, Documentation Hallucination Pattern.
• Context:
  • It can typically manifest Plausible Fiction through documentation fiction pattern naming conventions.
  • It can typically create Debugging Time Sinks via documentation fiction pattern misdirection.
  • It can typically erode Developer Trust using documentation fiction pattern false promises.
  • It can often propagate Fiction Viruses through documentation fiction pattern copy-paste.
  • It can often generate Support Burden via documentation fiction pattern confusion.
  • ...
  • It can range from being an Innocent Documentation Fiction Pattern to being a Malicious Documentation Fiction Pattern, depending on its documentation fiction pattern intent.
  • It can range from being a Obvious Documentation Fiction Pattern to being a Subtle Documentation Fiction Pattern, depending on its documentation fiction pattern detectability.
  • It can range from being a Local Documentation Fiction Pattern to being a Systemic Documentation Fiction Pattern, depending on its documentation fiction pattern spread.
  • It can range from being a Technical Documentation Fiction Pattern to being a Business Documentation Fiction Pattern, depending on its documentation fiction pattern domain.
  • ...
  • It can waste Developer Hours through documentation fiction pattern wild goose chases.
  • It can delay Feature Delivery via documentation fiction pattern false assumptions.
  • It can increase Onboarding Friction using documentation fiction pattern broken examples.
  • It can multiply Integration Failures through documentation fiction pattern wrong specifications.
  • It can reduce Team Velocity via documentation fiction pattern trust erosion.
  • ...
• Examples:
  • Ghost Variable Documentation Fiction Pattern, like `MODEL_NAME_*` or `*_TEMPERATURE` that never exist.
  • Round Number Documentation Fiction Pattern, claiming "100 requests/minute" or "20% improvement".
  • Plausible File Documentation Fiction Pattern, referencing `revise_engine.py` or `*_strategies.py`.
  • Symmetric Metric Documentation Fiction Pattern, showing "P50=2s, P95=5s, P99=8s".
  • Wrong Provider Documentation Fiction Pattern, documenting `OPENAI_API_KEY` when using Azure.
  • ...
• Counter-Examples:
  • Documentation Error, which is accidental mistake rather than documentation fiction pattern.
  • Documentation Gap, which is missing information rather than documentation fiction pattern.
  • Documentation Ambiguity, which is unclear wording rather than documentation fiction pattern.
• See: Documentation Anti-Pattern, Documentation Verification Protocol, Documentation Trust Score, Fiction Pattern Catalog, Documentation Acceleration Runbook, Documentation Corrective Action Process, Documentation Debt Management Strategy.

---