THE GITHTML FIELD GUIDE
Date and version the sources behind AI-generated documentation
To keep generated documentation accountable, record the exact code revision, dependency versions, and external sources used. A publication date alone does not establish freshness. Recheck claims when their supporting material changes, and tell readers whether the page describes current behavior, a historical release, or a proposal.
Track different kinds of time
The draft creation date, source retrieval date, release date, and last human review date answer different questions. An illustrative guide generated today from an older branch still describes that older branch unless reviewed against newer code. Record these distinctions near the document metadata instead of collapsing them into updated. GitHub's permanent links identify file content at a particular commit, which helps preserve evidence. Use moving links only when the reader intentionally needs the current resource, and explain when a stable snapshot is the basis of a claim.
Create a small source manifest
An illustrative manifest might list repository revision, contract version, dependency version, external reference title, retrieval date, and reviewer. Add a short note about what each source supports. A library's latest documentation may not apply to the version installed by the project, so compare the source to the lockfile or declared dependency. Avoid claiming that every source was reviewed if only a subset was inspected. Keep the manifest focused on evidence needed to interpret the document, not every file that happened to appear in the generator's context.
- Code claims: record the commit and relevant source locations.
- Dependency claims: match the reference version to the installed version.
- Review scope: name the sections verified and the questions still open.
Choose useful refresh triggers
A changed interface, moved ownership boundary, or altered data policy should trigger review even if the document is recently published. Conversely, a stable conceptual explanation may not need rewriting simply because a month has passed. Tie refresh work to meaningful changes and prioritize high-consequence statements. Preserve the original snapshot when it is needed to explain an older release. For a committed HTML guide, show the described version before the main explanation so a phone reader does not confuse a historical document with a live view of the repository.
Sources and further reading
AI-assisted writing with source-linked guidance and illustrative examples. Read our editorial approach or report a correction.