Check a Markdown documentation folder before handoff

A manual checklist for a Markdown documentation folder before handoff: relative links, local images, source files and the exported PDF or HTML copies.

Start from a manifest

The Markdown Handoff Kit contains a fictional specification, acceptance criteria, manifest and local SVG. Its manifest.md names every expected file. Compare that list with the extracted folder before opening a reader: missing assets are a packaging problem, not necessarily a rendering problem.

Walk the document like a recipient

Open README.md, follow the specification and its links to acceptance and manifest, then return. Check that the diagram resolves. Read the scope statement and look for open questions that should be answered before implementation. If you have a PDF or HTML copy, open that copy too: page breaks, text selection, headings and local images can change during export.

Use this sequence for your own handoff:

  1. List source files and assets in a manifest.
  2. Follow local links from the entry page, not only from a file manager.
  3. Check images, diagrams and code blocks.
  4. Open each exported format on another machine or in a fresh location.
  5. Mark untested items explicitly.

The kit includes source files only. It does not include a finished PDF or HTML file, so make those with a tool you trust and inspect the results. Aero Markdown does not automatically certify a folder. Its native export is still part of an app not publicly available yet.

For image failures, use the local-image guide; for choosing a handoff format, read sharing Markdown with a non-technical recipient.