Document-as-Code Lab

Source file

Publication Brief

Working template. Replace the prompts with your choices. For tutorial exercises, keep the fictional teaching-material label visible in the planned output.

Reader and Purpose

  • Publication name and format:
  • Audience and situation of use:
  • What readers should be able to do:
  • Person responsible for preparing and checking the output:

Source Selection

  • Repository or source location:
  • Source revision and any local changes:
  • Selected files, in reading order:
  • Included visuals and their source data:
  • Treatment of draft or unavailable content:
  • Information deliberately excluded:

Presentation

  • Navigation, section order, or slide sequence:
  • Explanations or examples added for this audience:
  • Template, reference document, or layout settings:
  • Accessibility requirements and static alternatives:

Build and Delivery

  • Tools, versions, and build command or manual steps:
  • Output location and exact edition or artifact identifier:
  • Intended readers and access restrictions:
  • Update method and responsibility:
  • Where corrections to shared facts should be recorded:

Review Record

  • Exact output inspected:
  • Source accuracy and selection checks:
  • Layout, links, visuals, and accessibility checks:
  • Reviewer, date, and findings:
  • Untested formats or unresolved issues:
  • Decision and scope: review copy, ready for further review, or accepted for the stated use: