agentleFS
MAGA2010MAGA2010/data-master/skills/report-generator/SKILL.md

report-generator

Skill78 starsChanged 23 days agoMITView on GitHub

Assemble report.md, executive_summary.md and report.pdf from the artifacts. Every number is registered against its source; the PDF is the primary deliverable and the Markdown is the citable source.

15 other projects use a version of this.

Adopted by

Most recently taken up by

The file

We split this skill into the rules it gives an agent

6 rules. 0 are common, 6 are distinctive, and 0 are very specific to this project.

  • 0

    Common

    Most of the 8 edited versions we read keep these.

  • 6

    Distinctive

    This author's own choices. Worth a look.

  • 0

    Very specific

    Tied to their project's names, files or tools. Probably skip.

  • Common
  • Distinctive
  • Very specific
  1. Distinctive:

    After figures render. Never before the statistical gates have artifacts to read -- a report written first is a report that has to be edited …

    line 17
  2. Distinctive:

    every number in the prose appears in the provenance table.

    line 41
  3. Distinctive:

    every forbidden construction is absent outside a disclaimer.

    line 42
  4. Distinctive:

    do not type a number into the report that was not read from an artifact.

    line 57
  5. Distinctive:

    do not treat a BLOCKED PDF as success -- the markdown is complete, the deliverable is not.

    line 58
  6. Distinctive:

    do not duplicate the executive summary's argument in the full report with different wording.

    line 60

“Common” is measured: kept by at least 6 in 10 of the 8 edited versions of this file we could read. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.

Keep what fits and drop the rest. Your version, ready for your agents.
Files
SKILL.md

report-generator

Stage 3b of the data-master pipeline. The router in ../../SKILL.md owns the end-to-end run; this skill owns one stage and one gate. Read the parent contract before changing anything here: the invariants in ../../SKILL.md (additive-only, types decided once, default-FAIL gates, three-part provenance) are not restated, they are inherited.

When to invoke

After figures render. Never before the statistical gates have artifacts to read -- a report written first is a report that has to be edited to fit the numbers.

Inputs

  • all of outputs/analysis/*.json
  • outputs/cleaned/cleaning_run.json
  • outputs/charts_rendered.json

Outputs

  • report.md -- full report, 6 sections + 4 appendices
  • executive_summary.md -- one page, same numbers
  • report.pdf -- A4, CJK-capable, page numbers, table of contents
  • report_build.json -- provenance for every number, PDF backend trail, self-audit

Commands

python scripts/assemble_report.py --raw <raw.csv> --outdir outputs --title "<title>"

Gate (default FAIL)

  • every number in the prose appears in the provenance table;
  • every forbidden construction is absent outside a disclaimer;
  • the PDF cascade records which backend ran and why earlier tiers were skipped;
  • report.md is complete even when the PDF is BLOCKED.

Failure modes seen in real runs

  • Self-referential hash. A document cannot contain its own sha256; the report points at report_build.json instead of printing a stale value.
  • A PDF backend that "works" but drops images. The browser tier embeds images as data URIs because file:// sandboxing silently loses them.
  • A missing CJK font rendered as black boxes. The reportlab tier falls back to a CID font and records whether it was embedded.

Do not

  • do not type a number into the report that was not read from an artifact;
  • do not treat a BLOCKED PDF as success -- the markdown is complete, the deliverable is not;
  • do not duplicate the executive summary's argument in the full report with different wording.

Upstream / downstream

  • previous: ../visualizer/SKILL.md
  • next: ../data-validator/SKILL.md
  • templates: ../../references/report-template-catalog.md

Download now (ZIP)

Does it work?

Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.

No reviews yet

People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.

  • It worked
  • Partly
  • It didn't
What did you use it for? e.g. Reviewing pull requests in a Rails app

Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.

Your trail

Files you open will collect here, so you can find them again.

Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.

Now do this for your own.

Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.