docs: documentation drift audit and rework tracking#233
Draft
vredchenko wants to merge 1 commit into
Draft
Conversation
The docs under docs/ have drifted from the code since the workspace tooling was split into smartem-devtools. Before rewriting blind, measure the drift: slice each how-to/reference/tutorial doc into content atoms, decompose prose into factual claims, and verify each against the repositories. Lands the analysis (verdicts.jsonl, REPORT.md, interactive drift-map.html) and the re-runnable slicer (atomize.py) as the tracking point for the rework.
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
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
Draft tracking PR for the documentation rework. Rather than rewrite the docs blind, this lands a
measured audit of how far the current docs have drifted from the code, so the rework can reuse what is
still true. Full detail in
doc-audit/REPORT.md; interactive view indoc-audit/drift-map.html.Every published how-to / reference / tutorial doc was sliced into line-anchored content atoms, each
prose atom decomposed into individual factual claims, and every claim checked against the real
repositories.
Results
64 docs -> 2,560 content atoms. Verifiable subset (how-to / reference / tutorial): 34 files -> 960 claims.
ADR/design docs parked (historical record, not drift).
79% of documented claims are true - the rework is a re-organise-and-fill exercise, not a blank page.
Key findings
misleading, not wrong: tooling movedsmartem-decisions->smartem-devtools, so documented commands/paths point at the wrong repo.athena_apipackage deleted under ADR 0015 - remove/rewrite.validateexits0when docs promise1(Typerignores the handler return);
--log-fileis a no-op;-v/--verboseis inconsistent across subcommands.Scope
This audit answers only "is what is written true?" It does not measure coverage gaps (undocumented
surface) or structure/consistency - the other two drivers of the rework. Those are tracked below.
Rework workstreams
misleadingclaims, mostly path re-homing tosmartem-devtoolsincorrectclaimstrueatoms--log-fileno-op, verbose-flag mismatchesNotes
Draft, not for merge - the primary purpose is to track the rework. Analysis data (
verdicts.jsonl) and there-runnable slicer (
atomize.py) travel with the branch so findings are auditable and refreshable.