Just-In-Time Documentation Principle
Jump to navigation
Jump to search
A Just-In-Time Documentation Principle is an agile documentation principle that defers documentation creation until the last responsible moment when its value is maximized.
- AKA: JIT Documentation Principle, Lean Documentation Principle, Deferred Documentation Guideline.
- Context:
- It can typically maximize Documentation Value Delivery through just-in-time documentation principle relevance.
- It can typically enhance Decision Quality via just-in-time documentation principle context richness.
- It can typically amplify Knowledge Transfer Effectiveness using just-in-time documentation principle immediacy.
- It can often accelerate Feature Delivery Value through just-in-time documentation principle focus.
- It can often increase Documentation Impact via just-in-time documentation principle precision.
- ...
- It can range from being a Strict Just-In-Time Documentation Principle to being a Flexible Just-In-Time Documentation Principle, depending on its just-in-time documentation principle enforcement.
- It can range from being a Code-First Just-In-Time Documentation Principle to being a Design-First Just-In-Time Documentation Principle, depending on its just-in-time documentation principle sequence.
- It can range from being a Minimal Just-In-Time Documentation Principle to being a Comprehensive Just-In-Time Documentation Principle, depending on its just-in-time documentation principle scope.
- It can range from being a Pull-Based Just-In-Time Documentation Principle to being a Push-Based Just-In-Time Documentation Principle, depending on its just-in-time documentation principle trigger.
- ...
- It can enable Agile Sprint Execution through just-in-time documentation principle velocity.
- It can support Continuous Delivery via just-in-time documentation principle automation.
- It can facilitate Team Collaboration using just-in-time documentation principle communication.
- ...
- Examples:
- API Just-In-Time Documentation Principle, documenting API endpoints only after interface stabilization.
- Architecture Just-In-Time Documentation Principle, capturing architectural decisions when implementation patterns emerge.
- User Story Just-In-Time Documentation Principle, writing acceptance criteria during sprint planning.
- ...
- Counter-Examples:
- Big Design Up Front Documentation, which creates comprehensive specifications before implementation.
- Waterfall Documentation Principle, which requires complete documentation at phase gates.
- Regulatory Documentation Principle, which mandates upfront documentation for compliance.
- See: Agile Documentation Principle, Documentation Maintenance Strategy, Documentation Freshness Measure, Lean Software Development, Documentation Quality Target, Documentation Management Domain, Agile Manifesto.