ADR 006: Code-Outward Documentation#79
Merged
Merged
Conversation
absoludity
approved these changes
Jan 19, 2026
absoludity
left a comment
absoludity
left a comment
Collaborator
There was a problem hiding this comment.
I like this. Reading it make me wonder if this documentation issue is a long-standing issue you've been keen solve once and for all for a while?
| API docs. This creates drift, duplication, and maintenance burden. | ||
|
|
||
| The doctrine system (ADR 002) establishes that tests ARE the specification. The same | ||
| principle applies to documentation: **docstrings ARE the documentation**. |
Collaborator
There was a problem hiding this comment.
Is it all based on python docstrings only? If not, maybe:
Suggested change
| principle applies to documentation: **docstrings ARE the documentation**. | |
| principle applies to documentation: **the code documentation IS the documentation**. |
though that doesn't quite capture it. Maybe docstrings is fine - by which we just mean generally high-level (module/function) code documentation, I guess?
Contributor
Author
|
maybe - It is a bit of a manifesto, isn't it. I may have been arguing with / lecturing the LLM about slop minimisation... |
Cherry-picked from super-branch (PR #56). Documents the "docstrings ARE the documentation" principle: - Framework provides semantic scaffolding, solutions provide content - Viewpoints are projections through framework BCs - Bespoke templates per entity type - Code exists → autodoc; code doesn't exist → design doc Closes #70
monkeypants
force-pushed
the
adr-006-code-outward-documentation
branch
from
cd2f253 to
23017ab
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Cherry-picks ADR 006 from the super-branch (PR #56).
Documents the "docstrings ARE the documentation" principle:
Related
Closes #70
Cherry-picked from PR #56
Test plan