THE GITHTML FIELD GUIDE · 150 ARTICLES
Practical answers for the documents in your repos. Build a portable report, fix a broken page, or borrow a template for your next technical review.
Make repository documents readable away from your desk: choose a portable format, prepare the file, and understand what a reader can open.
Reading HTML on your phone · 2 min
Prepare a GitHub HTML document for focused iPhone reading, with a clear entry point, readable layout, and a dependable static fallback.
Read guide : Read a repository HTML document comfortably on iPhoneReading HTML on your phone · 2 min
Create a portable HTML reading artifact by keeping essential text and CSS together and deliberately handling images and external dependencies.
Read guide : Build a single-file HTML document that travels wellReading HTML on your phone · 2 min
Prevent a report from appearing as a tiny desktop page on iPhone by setting a sensible viewport and removing conflicting width rules.
Read guide : Set a mobile viewport for an HTML reportReading HTML on your phone · 2 min
Build a static table of contents with stable fragment links so a lengthy HTML report remains navigable on a small screen.
Read guide : Add useful section navigation to a long HTML documentReading HTML on your phone · 2 min
Choose wrapping, local scrolling, and example boundaries that preserve code meaning without forcing an entire HTML page sideways.
Read guide : Format code samples for reading on an iPhoneReading HTML on your phone · 2 min
Reduce a dense comparison to the columns readers need and preserve genuine table relationships when the remaining data is still wide.
Read guide : Make a comparison table usable on a small screenReading HTML on your phone · 2 min
Export diagrams into static reading artifacts and accompany them with text so an HTML report stays useful when scripts are off.
Read guide : Include diagrams without a runtime rendering dependencyReading HTML on your phone · 2 min
Organize secondary material with HTML details and summary while leaving essential decisions and warnings visible to every reader.
Read guide : Use native disclosure sections for optional appendicesReading HTML on your phone · 2 min
Use system fonts, relative sizing, and restrained line lengths to keep a portable HTML document readable without downloading web fonts.
Read guide : Choose dependable typography for portable HTMLReading HTML on your phone · 2 min
Define coordinated light and dark colors for text, surfaces, code, and diagrams instead of relying on an accidental inverted appearance.
Read guide : Give an HTML reading document a deliberate dark appearanceReading HTML on your phone · 2 min
Choose essential illustrations, reduce unnecessary image weight, and keep the report understandable when an external picture is unavailable.
Read guide : Decide which images belong inside a portable HTML reportReading HTML on your phone · 2 min
Use concise labels and ordinary document structure to make warnings, notes, and decisions understandable without scripts or color alone.
Read guide : Write HTML callouts that clarify warnings and decisionsReading HTML on your phone · 2 min
Create readable source notes with stable links, contextual labels, and practical return navigation in a long HTML document.
Read guide : Keep citations and footnotes usable on a phoneReading HTML on your phone · 2 min
Reorganize dashboard content into a coherent HTML narrative that works on iPhone without relying on a grid or visual position.
Read guide : Turn a desktop dashboard export into a linear reading documentReading HTML on your phone · 2 min
Add a restrained print stylesheet while keeping the same report readable on screen, with visible evidence and sensible page boundaries.
Read guide : Prepare an HTML report for both phone reading and printingReading HTML on your phone · 2 min
Check completeness, mobile layout, navigation, and dependencies before handing a repository HTML document to an iPhone reader.
Read guide : Run a five-minute readiness review before sharing HTMLFind out why a document is blank, unstyled, incomplete, or difficult to navigate. Diagnose the dependency before changing reader settings.
HTML troubleshooting · 2 min
Distinguish an empty application shell from a readable HTML document and recover useful content without indiscriminately enabling scripts.
Read guide : Diagnose a blank HTML page when JavaScript is offHTML troubleshooting · 2 min
Trace missing stylesheet dependencies, path assumptions, and export omissions before deciding whether an unstyled document needs a new artifact.
Read guide : Find why an HTML document opens without its stylingHTML troubleshooting · 2 min
Resolve image references against the document location and distinguish a correct repository path from an asset the reader can actually retrieve.
Read guide : Troubleshoot broken relative image paths in repository HTMLHTML troubleshooting · 2 min
Recognize when an image reference points to a repository browsing page and replace it with an appropriate, authorized resource or embedded asset.
Read guide : Distinguish a GitHub file page from an image resource URLHTML troubleshooting · 2 min
Isolate the widest content block, repair its layout rules, and keep code or tables locally scrollable without hiding useful information.
Read guide : Find the element making an HTML document scroll sidewaysHTML troubleshooting · 2 min
Identify encoding mismatches at the source, declare UTF-8 correctly, and avoid repeatedly re-saving already damaged text.
Read guide : Repair garbled punctuation and characters in an HTML exportHTML troubleshooting · 2 min
Check fragment spelling, unique IDs, generated heading changes, and obscured targets when an HTML table of contents behaves incorrectly.
Read guide : Fix section links that do not reach the right headingHTML troubleshooting · 2 min
Inspect a base URL before debugging many broken links, images, or styles in an exported HTML document that has moved contexts.
Read guide : Find hidden URL assumptions introduced by an HTML base elementHTML troubleshooting · 2 min
Trace font dependencies, restore reliable fallback typography, and replace icon-font-only meaning in a portable HTML reading artifact.
Read guide : Recover readable text when a web font failsHTML troubleshooting · 2 min
Trace mismatched foreground and background colors across callouts, tables, and code blocks instead of applying a blanket inversion filter.
Read guide : Fix invisible text in a dark HTML documentHTML troubleshooting · 2 min
Separate file permissions from HTML path errors and choose a safe packaging approach without putting access credentials into the document.
Read guide : Diagnose missing images from a private repositoryHTML troubleshooting · 2 min
Handle unavailable iframe content by publishing a clear static summary, dated values, and source context rather than a blank embedded panel.
Read guide : Replace missing embedded dashboards with a readable snapshotHTML troubleshooting · 2 min
Turn a runtime-only chart into a static explanation with visible values, a dated visual, and a useful fallback for portable HTML reading.
Read guide : Recover a chart that disappears when scripts are disabledHTML troubleshooting · 2 min
Find dependencies supplied by your development environment and inspect the actual exported artifact in a clean reading context.
Read guide : Why an HTML file works locally but fails after sharingHTML troubleshooting · 2 min
Escape source examples correctly so tags remain visible as selectable code instead of becoming accidental elements in the reading document.
Read guide : Stop HTML examples from being interpreted as page markupHTML troubleshooting · 2 min
Inspect the SVG viewBox, fixed dimensions, labels, and surrounding layout before scaling or cropping an important technical diagram.
Read guide : Fix an SVG diagram that is clipped or tiny on a phoneHTML troubleshooting · 2 min
Diagnose video dependencies while preserving the tutorial through a transcript, timestamps, and still images that do not require playback.
Read guide : Keep a tutorial useful when its embedded video will not playHTML troubleshooting · 2 min
Recognize partial markup exported from a component and add the document metadata, context, and styling needed for independent reading.
Read guide : Turn an HTML fragment into a complete reading artifactWrite documents people can navigate, zoom, listen to, and read comfortably. Practical HTML patterns for code, tables, images, and headings.
Accessible documentation · 2 min
Organize HTML headings by meaning so readers can skim the argument visually or move through it using assistive technology.
Read guide : Build a heading outline that makes a long report navigableAccessible documentation · 2 min
Mark the main content and navigation areas of a static HTML report without turning every small panel into a competing landmark.
Read guide : Use landmarks to separate navigation from the report bodyAccessible documentation · 2 min
Describe the purpose of a screenshot in its surrounding task, and move lengthy instructions or evidence into readable HTML text.
Read guide : Write screenshot alternatives that explain the useful informationAccessible documentation · 2 min
Write a structured text equivalent for a system diagram so its flow, boundaries, and failure paths remain available without the visual.
Read guide : Describe architecture diagrams as relationships, not shapesAccessible documentation · 2 min
Use captions, header cells, and explicit units to make report tables understandable beyond their visual grid and color styling.
Read guide : Give data tables headers that survive nonvisual readingAccessible documentation · 2 min
Replace vague link labels with concise destination names and distinguish document navigation from optional external references.
Read guide : Write links that remain meaningful outside their paragraphAccessible documentation · 2 min
Give multilingual reports explicit language metadata and appropriate direction so text, punctuation, and assistive reading have useful context.
Read guide : Declare language and text direction in multilingual HTMLAccessible documentation · 2 min
Remove layout constraints that clip or overlap content when readers zoom, enlarge text, or use a narrow viewing area.
Read guide : Keep an HTML report readable when text is enlargedAccessible documentation · 2 min
Pair status colors with explicit words and meaningful context so review results remain clear in dark mode, grayscale, or nonvisual reading.
Read guide : Make report statuses understandable without colorAccessible documentation · 2 min
Review link order, focus visibility, disclosures, and scrollable areas without introducing unnecessary custom interaction into a reading artifact.
Read guide : Check keyboard navigation in a static HTML reportAccessible documentation · 2 min
Space section links, footnotes, and disclosure summaries so a phone reader can choose the intended destination without accidental taps.
Read guide : Give document navigation enough space for touchAccessible documentation · 2 min
Remove distracting animation from reports and respect reduced-motion preferences without making content depend on a visual transition.
Read guide : Keep motion optional in an HTML reading documentAccessible documentation · 2 min
Find fixed-height and tightly packed components that lose content when line, word, letter, or paragraph spacing is increased.
Read guide : Make HTML layouts tolerate a reader's text-spacing preferencesAccessible documentation · 2 min
Pair selectable code with concise explanations of its purpose, inputs, and important lines so syntax colors are not the only guide.
Read guide : Explain code samples for readers who cannot rely on highlightingAccessible documentation · 2 min
Define unfamiliar terms where readers need them and build a compact glossary that works without hover tooltips or external lookups.
Read guide : Make specialist terminology easier to follow in an HTML reportAccessible documentation · 2 min
Combine structural, visual, keyboard, and nonvisual checks while documenting the scope and limits of your review honestly.
Read guide : Run a practical accessibility review of a static HTML artifactOrganize repository knowledge, link to the right version, and diagnose access problems without turning reading into a deployment project.
GitHub documentation workflows · 2 min
Find the right starting point in a large documentation repository with a short, read-only inventory and a purpose-based reading map.
Read guide : Map an unfamiliar documentation repository before readingGitHub documentation workflows · 2 min
Separate readable HTML output from Markdown sources and application templates using a precise repository file inventory.
Read guide : Find actual HTML documents in a GitHub repositoryGitHub documentation workflows · 2 min
Replace moving branch links with commit-based document links so reviewers can return to the same text after later edits.
Read guide : Share a GitHub document at an exact revisionGitHub documentation workflows · 2 min
Pick the right Git reference for current instructions, release manuals, and reproducible reviews without changing your checkout.
Read guide : Choose branch, tag, or commit references for documentationGitHub documentation workflows · 2 min
Use git show to inspect a historical documentation file while keeping your current checkout and unfinished work untouched.
Read guide : Read an older document without switching branchesGitHub documentation workflows · 2 min
Review changed instructions across two versions using a path-scoped diff and a reader-focused change checklist.
Read guide : Compare documentation between two releases with Git diffGitHub documentation workflows · 2 min
Follow a file’s recorded history to find the change that introduced an instruction, then read the surrounding commit context.
Read guide : Trace why a documentation page changedGitHub documentation workflows · 2 min
Use git grep to locate exact terms in a repository snapshot and distinguish matching source text from a usable reading page.
Read guide : Search tracked documentation without opening every fileGitHub documentation workflows · 2 min
Trace a confusing instruction to its recorded change while avoiding misleading conclusions about ownership or responsibility.
Read guide : Use Git blame to locate documentation context, not assign faultGitHub documentation workflows · 2 min
Check version labels, prerequisites, navigation, and changed instructions before a release without modifying repository content.
Read guide : Run a read-only release documentation reviewGitHub documentation workflows · 2 min
Identify which files should be edited and which files readers need, so documentation fixes survive the next local build.
Read guide : Separate authoring sources from generated HTMLGitHub documentation workflows · 2 min
Create a predictable documentation folder structure with stable filenames, clear ownership, and explicit entry points.
Read guide : Organize repository HTML paths around reader tasksGitHub documentation workflows · 2 min
Check account identity, organization approval, and repository access without weakening visibility or exposing credentials.
Read guide : Diagnose a private repository missing from a reading appGitHub documentation workflows · 3 min
Evaluate an app authorization request against your reading task and organization policy before granting repository access.
Read guide : Review GitHub permissions before connecting a document readerGitHub documentation workflows · 2 min
Inventory incoming links and historical references before reorganizing documentation paths, then verify the new reading route.
Read guide : Plan a documentation move without losing reader contextGitHub documentation workflows · 2 min
Preserve old decisions and manuals while making support status, replacement instructions, and version boundaries unmistakable.
Read guide : Label historical documentation so readers do not mistake it for current guidanceGitHub documentation workflows · 2 min
Attach source revision, export context, and intended audience to an HTML reading copy so it remains understandable outside its original folder.
Read guide : Record provenance inside an HTML documentation copyGitHub documentation workflows · 2 min
Create a compact document handoff with the correct version, ordered pages, access assumptions, and questions to resolve.
Read guide : Hand off a repository reading route to a teammatePrepare documents before travel, check what is really downloaded, and keep useful references available when the connection disappears.
Offline reading · 2 min
Test the actual documents, assets, and navigation you will need before losing connectivity instead of relying on an online preview.
Read guide : Run an offline documentation preflight before travelOffline reading · 2 min
Identify external styles, images, fonts, scripts, and linked chapters before deciding whether an HTML file is portable.
Read guide : Inventory an HTML document’s offline dependenciesOffline reading · 2 min
Keep a document’s essential styling inside its HTML file and avoid hidden font, image, and stylesheet dependencies.
Read guide : Use inline CSS for a dependable portable reading copyOffline reading · 2 min
Keep essential architecture and process diagrams understandable through portable assets, captions, and complete text explanations.
Read guide : Prepare diagrams that remain useful offlineOffline reading · 2 min
Use in-document anchors, descriptive links, and explicit remote-reference labels so a saved handbook remains navigable.
Read guide : Design navigation for an offline HTML handbookOffline reading · 2 min
Convert dashboards, forms, and interactive examples into dated snapshots and clear instructions without implying live functionality.
Read guide : Replace live widgets with honest offline informationOffline reading · 2 min
Preserve source attribution and useful context while making it clear which linked material cannot be opened without connectivity.
Read guide : Handle external references in an offline reading packetOffline reading · 2 min
Learn why a page that loaded once is not proof of durable offline availability and how to check the actual reading copy.
Read guide : Understand browser cache versus a saved reading documentOffline reading · 2 min
Update a reading packet with explicit revision labels and targeted checks so old procedures do not linger beside new instructions.
Read guide : Refresh offline documentation without mixing versionsOffline reading · 2 min
Reduce unnecessary assets and divide oversized handbooks by task while preserving complete, testable reading units.
Read guide : Keep large offline HTML packets manageableOffline reading · 2 min
Plan authorized device use, distribution, and retention for private documentation without assuming offline copies lose their sensitivity.
Read guide : Handle confidential documentation in offline reading workflowsOffline reading · 2 min
Choose a realistic reading goal, package the right HTML pages, and test the exact route before leaving network coverage.
Read guide : Prepare a focused flight reading packet from repository documentsOffline reading · 2 min
Package essential incident guidance with version context, prerequisites, escalation routes, and explicit live-system boundaries.
Read guide : Prepare an offline incident runbook that states its limitsOffline reading · 2 min
Review headings, core text, navigation, and interactive dependencies before relying on an HTML document in a script-disabled reader.
Read guide : Check whether documentation remains useful without JavaScriptUnderstand documentation generators, HTML exports, and portable reading copies. Local build recipes with clear limits and verification steps.
Documentation builds and formats · 2 min
Create a complete HTML reading document from Markdown locally, then verify structure, metadata, and resource dependencies.
Read guide : Convert Markdown to standalone HTML with PandocDocumentation builds and formats · 2 min
Use Pandoc’s resource embedding option while checking external requests, dynamic content, and the limits of a self-contained export.
Read guide : Embed resources in a Pandoc HTML export carefullyDocumentation builds and formats · 2 min
Build an ordered single-file handbook with Pandoc while checking chapter boundaries, heading structure, and cross-references.
Read guide : Combine Markdown chapters into one HTML handbookDocumentation builds and formats · 2 min
Record conversion settings beside the source so future local HTML exports use a consistent format, resource policy, and output path.
Read guide : Make Pandoc HTML exports repeatable with a defaults fileDocumentation builds and formats · 2 min
Generate and inspect an existing MkDocs project locally while keeping source files, build output, and publication separate.
Read guide : Build MkDocs HTML locally before sharing itDocumentation builds and formats · 2 min
Understand directory-style URLs, direct HTML filenames, and why a MkDocs file export still needs dependency checks.
Read guide : Configure MkDocs links for file-oriented readingDocumentation builds and formats · 2 min
Generate an existing Sphinx project’s HTML output locally and inspect warnings, cross-references, and reader-facing structure.
Read guide : Build Sphinx HTML for a local documentation reviewDocumentation builds and formats · 2 min
Combine a Sphinx document tree into a long HTML page while checking supporting assets and navigation before offline use.
Read guide : Use Sphinx singlehtml without assuming a self-contained fileDocumentation builds and formats · 2 min
Inspect an existing Docusaurus production build locally without confusing generated static files with publication or a single-file export.
Read guide : Build Docusaurus for a local documentation reviewDocumentation builds and formats · 2 min
Diagnose root-relative asset and route assumptions when a Docusaurus site moves under a subpath or into a reading workflow.
Read guide : Review Docusaurus base paths before exporting documentationDocumentation builds and formats · 2 min
Build a focused TypeScript API reference locally and verify that the output describes the interface your readers actually use.
Read guide : Generate TypeDoc HTML from a public entry pointDocumentation builds and formats · 2 min
Use explicit entry points and review inclusion rules so generated API documentation does not expose an accidental implementation surface.
Read guide : Control TypeDoc scope before sharing an API referenceDocumentation builds and formats · 2 min
Build documentation for an existing Swift package with the configured DocC plugin and understand what the resulting archive contains.
Read guide : Generate a Swift DocC archive locallyDocumentation builds and formats · 2 min
Understand why a statically hosted DocC archive can still use an application runtime and needs separate offline-reader verification.
Read guide : Distinguish DocC static hosting from portable HTMLDocumentation builds and formats · 2 min
Choose a maintainable policy for generated HTML artifacts without confusing repository presence with publication or source authority.
Read guide : Version documentation source and generated output deliberatelyDocumentation builds and formats · 2 min
List document paths, revisions, dependencies, and verification status so a released reading packet can be checked and refreshed.
Read guide : Create a manifest for a documentation release packetDocumentation builds and formats · 3 min
Match a focused handbook, structured site, or generated API reference to an appropriate local build workflow and output check.
Read guide : Choose a documentation export tool by the reading taskDocumentation builds and formats · 3 min
Understand the separate roles of building, serving locally, publishing, and reading saved HTML before sharing a documentation result.
Read guide : Distinguish local documentation preview from hostingUseful starting points for decisions, runbooks, onboarding, releases, and handoffs. Examples that make missing information visible.
Documentation templates · 2 min
Record an architecture choice, rejected alternatives, evidence, and a clear trigger for reconsidering it in a portable HTML decision record.
Read guide : Architecture decision record template with review triggersDocumentation templates · 2 min
Build a runbook that separates observation from intervention, names prerequisites, and gives responders concrete stop and escalation conditions.
Read guide : Operational runbook template with safe stop conditionsDocumentation templates · 2 min
Structure onboarding around a verified local setup, a small first change, and clear help routes instead of an overwhelming repository tour.
Read guide : Developer onboarding guide template for a first useful changeDocumentation templates · 2 min
Plan a migration using inventory, compatibility checks, staged evidence, and explicit rollback limits before anyone changes production.
Read guide : Software migration plan template with exit and rollback gatesDocumentation templates · 2 min
Write release notes that tell readers what changed, who is affected, what action is required, and where important limitations remain.
Read guide : Release notes template that explains user impactDocumentation templates · 2 min
Maintain a readable version history with categorized changes, exact dates, and links that help maintainers compare releases confidently.
Read guide : Maintainer changelog template for dependable version historyDocumentation templates · 2 min
Capture incident impact, a sourced timeline, contributing conditions, and assigned follow-up without confusing hypotheses with established causes.
Read guide : Incident review template focused on evidence and follow-upDocumentation templates · 2 min
Document one API operation with inputs, response shapes, authorization boundaries, error cases, and examples that match the declared contract.
Read guide : API reference page template with request and error examplesDocumentation templates · 2 min
Create an architecture overview that names users, responsibilities, dependencies, and failure boundaries without burying readers in implementation detail.
Read guide : Architecture overview template that explains system boundariesDocumentation templates · 2 min
Build a service catalog entry that identifies responsibility, support boundaries, escalation routes, and the documents maintainers need.
Read guide : Service ownership catalog template for clear handoffsDocumentation templates · 2 min
Connect a test strategy to user risks, system boundaries, representative cases, and clear evidence instead of relying on coverage percentages.
Read guide : Test strategy template organized around product riskDocumentation templates · 2 min
Document a performance question, measurement conditions, baseline, uncertainty, and follow-up without turning one fast run into a broad claim.
Read guide : Performance investigation report template with reproducible evidenceDocumentation templates · 2 min
Explain data fields with business meaning, units, null behavior, sources, ownership, and retention references in a practical dictionary.
Read guide : Data dictionary template with meaning, ownership, and lifecycleDocumentation templates · 2 min
Review an upgrade using verified release notes, affected integration points, migration needs, and reproducible checks before approving it.
Read guide : Dependency upgrade review template for compatibility decisionsDocumentation templates · 2 min
Document a feature flag's purpose, owner, exposure rules, dependencies, verification, and retirement conditions so temporary controls stay temporary.
Read guide : Feature flag lifecycle template from introduction to removalDocumentation templates · 2 min
Summarize assets, trust boundaries, plausible abuse paths, existing controls, and unresolved risks in a readable threat-model review document.
Read guide : Threat model summary template for a focused design reviewDocumentation templates · 2 min
Build a troubleshooting tree around observable questions, evidence capture, and explicit escalation instead of speculative fixes.
Read guide : Troubleshooting decision tree template with discriminating checksDocumentation templates · 2 min
Prepare a human-run release checklist covering revision identity, compatibility, approvals, recovery prerequisites, and post-release evidence.
Read guide : Manual release readiness checklist template with accountable gatesDocumentation templates · 2 min
Write a deprecation notice that names the affected behavior, supported replacement, migration evidence, and removal policy without ambiguity.
Read guide : Deprecation notice template with a clear replacement pathDocumentation templates · 2 min
Create a handoff that records current state, evidence, open decisions, safe next steps, and ownership without making the next engineer reconstruct history.
Read guide : Technical handoff template for unfinished engineering workAsk for source-backed documentation, verify generated claims, and turn an agent's output into something a teammate can trust and read.
Working with AI-written docs · 2 min
Specify approved inputs, prohibited actions, evidence requirements, and output format before using a separate AI tool to draft repository documentation.
Read guide : Write a read-only AI documentation prompt with explicit boundariesWorking with AI-written docs · 2 min
Track generated claims against source locations, revisions, confidence, and reviewer decisions so unsupported statements do not disappear into polished prose.
Read guide : Build an evidence ledger for AI-generated documentationWorking with AI-written docs · 2 min
Check generated endpoint names, parameters, defaults, errors, and authorization statements against a versioned API contract and source evidence.
Read guide : Verify AI-generated API documentation against the actual contractWorking with AI-written docs · 2 min
Check generated architecture diagrams against source evidence, ownership boundaries, direction labels, and a text explanation before sharing them.
Read guide : Review AI-generated architecture diagrams for invented relationshipsWorking with AI-written docs · 2 min
Review generated snippets for real APIs, version assumptions, side effects, placeholders, and reproducible validation before readers copy them.
Read guide : Verify AI-generated documentation code examples before publicationWorking with AI-written docs · 2 min
Prevent stale generated guidance by recording repository revisions, dependency versions, source dates, and the limits of each review.
Read guide : Date and version the sources behind AI-generated documentationWorking with AI-written docs · 2 min
Replace vague confidence language with explicit evidence, bounded inferences, unknowns, and the next question a maintainer can answer.
Read guide : Label uncertainty in AI-generated documentation without losing usefulnessWorking with AI-written docs · 2 min
Handle disagreements between code, tests, contracts, and existing docs by recording scope and ownership instead of letting an AI draft choose silently.
Read guide : Resolve conflicting sources in an AI documentation draftWorking with AI-written docs · 2 min
Prepare minimal, approved source excerpts with synthetic examples and clear redaction notes before using a separate AI tool for documentation.
Read guide : Redact repository evidence before sending it to an AI documentation toolWorking with AI-written docs · 2 min
Keep repository comments, fetched pages, and embedded instructions in the evidence role when an AI tool helps draft technical documentation.
Read guide : Review documentation inputs for prompt-injection attemptsWorking with AI-written docs · 2 min
Regenerate only the affected explanation, preserve verified context, and review a semantic diff when code changes invalidate part of a document.
Read guide : Update AI-assisted documentation after a focused code changeWorking with AI-written docs · 2 min
Build a reliable glossary by tying domain terms to usage, distinguishing overloaded names, and resisting definitions inferred only from identifiers.
Read guide : Review an AI-generated project glossary for overloaded termsWorking with AI-written docs · 2 min
Verify that generated release notes describe shipped changes, affected users, and required actions without exposing internal material or overstating benefits.
Read guide : Review AI-generated release notes against shipped behaviorWorking with AI-written docs · 2 min
Check generated setup instructions for declared versions, missing access prerequisites, observable checkpoints, and a realistic first task.
Read guide : Review an AI-generated onboarding guide with a clean-environment checklistWorking with AI-written docs · 2 min
Review factual claims, examples, privacy, accessibility, revision scope, and rendering before committing an AI-assisted guide for readers.
Read guide : Publication checklist for an AI-assisted HTML guideReview architecture, testing, data flows, and release plans with focused questions. Capture findings that can be acted on back at your desk.
Technical review checklists · 2 min
Use a compact architecture review packet to check responsibilities, dependencies, and failure boundaries while reserving final decisions for deeper review.
Read guide : Review architecture boundaries from a phone without losing contextTechnical review checklists · 2 min
Follow one data item from entry to storage and deletion, checking transformations, trust boundaries, ownership, and evidence at each handoff.
Read guide : Trace data flow through a technical review documentTechnical review checklists · 2 min
Evaluate a query-plan report using the exact query, schema, statistics, environment, and execution caveats before recommending an index or rewrite.
Read guide : Review a PostgreSQL query-plan report safelyTechnical review checklists · 2 min
Check workload comparability, measurement windows, sample context, distributions, and user impact before accepting a performance conclusion.
Read guide : Review performance claims without being fooled by one fast runTechnical review checklists · 2 min
Assess whether tests protect meaningful behavior by tracing risk, setup, assertions, boundaries, and known gaps in a focused review.
Read guide : Review test coverage by reading assertions, not percentagesTechnical review checklists · 2 min
Check job identity, delivery assumptions, retries, deduplication, state transitions, and failure ownership in an asynchronous workflow review.
Read guide : Review an asynchronous job design for retries and ownershipTechnical review checklists · 2 min
Evaluate cache keys, freshness rules, invalidation, user isolation, and failure behavior before accepting a caching performance proposal.
Read guide : Review a caching design for freshness and isolationTechnical review checklists · 2 min
Check actors, resources, operations, enforcement points, and denial behavior without mistaking a hidden button for an authorization control.
Read guide : Review authorization boundaries from a technical design documentTechnical review checklists · 2 min
Assess configuration defaults, precedence, validation, reload behavior, compatibility, and secret handling using a small evidence-based review.
Read guide : Review configuration changes without exposing secretsTechnical review checklists · 2 min
Check error classification, response consistency, client recovery, information disclosure, and tests in a focused API error-handling review.
Read guide : Review API error handling as part of the user contractTechnical review checklists · 2 min
Check compatibility, stored data, external effects, recovery prerequisites, and decision ownership before accepting a rollback claim.
Read guide : Review rollback readiness beyond reverting application codeTechnical review checklists · 2 min
Use a short mobile pass to identify blockers, missing evidence, and focused follow-up while separating triage from full technical approval.
Read guide : Triage a technical review from your phone without over-approvingTechnical review checklists · 2 min
Turn a suspected issue into a clear finding with a condition, source evidence, concrete consequence, and proportionate next step.
Read guide : Write evidence-backed technical review findingsTechnical review checklists · 2 min
Evaluate whether logs, metrics, and traces answer specific operational questions while controlling sensitive data and documenting important blind spots.
Read guide : Review an observability plan by asking what a responder can learnTechnical review checklists · 2 min
Evaluate a debt-reduction proposal with observed friction, affected work, options, costs, and a bounded verification plan instead of a broad rewrite narrative.
Read guide : Review a technical debt proposal using concrete maintenance costs