Documentation Principle

lesson workflow active workflow/documentation-principle.md View on GitHub

Documentation Principle

Rule

Only document if it will be read and used within next few conversations.

Context

When deciding whether to create documentation during autonomous operation.

Detection

Observable signals indicating documentation debt:

Pattern

Strategic documentation decisions based on usage:

Context files (agent config):
  → Always read in future runs ✓

README updates:
  → Users/maintainers will read ✓

One-time investigation:
  → Won't be referenced again ✗

Lessons from recurring issues:
  → Prevents future mistakes ✓

Outcome

Following this principle leads to:

Related

Match Keywords

let me document this worth documenting create a knowledge article update the knowledge base document the finding