Skill Tracer
Skills › Scientific Agent Skills › scientific-writing › professional_report_formatting.md

professional_report_formatting.md

82 lines · skills/scientific-writing/references/professional_report_formatting.md at 5f2bc03

Open on GitHub
1# Safe Formatting for Reports and Manuscripts
2

Safe Formatting for Reports and Manuscripts

Raw lines 1 to 2
3## Content before presentation
4
5The former LaTeX style and demonstration report were removed. They could turn
6plausible-looking placeholder findings into a polished PDF. This version uses
7format-neutral Markdown and JSON/CSV registries so incompleteness remains visible.
8
9Do not format a draft as submission-ready while any verification gate is incomplete.
10Visual polish is not evidence.

Content before presentation

The former LaTeX style and demonstration report were removed. They could turn plausible-looking placeholder findings into a polished PDF. This version uses format-neutral Markdown and JSON/CSV registries so incompleteness remains visible.

Do not format a draft as submission-ready while any verification gate is incomplete. Visual polish is not evidence.

Raw lines 3 to 11
12## Workflow
141. Create a local scaffold.
152. Draft and verify content in Markdown.
163. Run manifest, claim, reference, consistency, authorship, coverage, and lint checks.
174. Obtain accountable human approval.
185. Copy the verified content into the current venue template.
196. Re-run checks that remain applicable and inspect the rendered output manually.
21For a journal or conference, use its current author instructions and official template.
22For an institutional report or thesis, use the institution's controlled template.

Workflow

  1. Create a local scaffold.
  2. Draft and verify content in Markdown.
  3. Run manifest, claim, reference, consistency, authorship, coverage, and lint checks.
  4. Obtain accountable human approval.
  5. Copy the verified content into the current venue template.
  6. Re-run checks that remain applicable and inspect the rendered output manually.

For a journal or conference, use its current author instructions and official template. For an institutional report or thesis, use the institution's controlled template.

Raw lines 12 to 23
24## Fail-closed placeholder policy
26Permitted draft markers are intentionally conspicuous, such as `[[TODO:...]]`. The
27language linter treats them as errors. Never replace an unresolved marker with generic
28boilerplate, a guessed number, a fabricated statement, or an invented citation.
30Keep:
32- `submission_ready` false;
33- the draft banner visible;
34- missing declaration statuses explicit;
35- human and confidentiality gates incomplete;
37until the underlying records are verified.

Fail-closed placeholder policy

Permitted draft markers are intentionally conspicuous, such as [[TODO:...]]. The language linter treats them as errors. Never replace an unresolved marker with generic boilerplate, a guessed number, a fabricated statement, or an invented citation.

Keep:

  • submission_ready false;
  • the draft banner visible;
  • missing declaration statuses explicit;
  • human and confidentiality gates incomplete;

until the underlying records are verified.

Raw lines 24 to 38
39## Headings and navigation
41- Use a single title and logical heading levels.
42- Preserve heading order when converting formats.
43- Include lists of tables or figures only when useful or required.
44- Use stable internal labels for tables, figures, appendices, and supplements.
45- Ensure generated bookmarks and reading order match the visible structure.

Headings and navigation

  • Use a single title and logical heading levels.
  • Preserve heading order when converting formats.
  • Include lists of tables or figures only when useful or required.
  • Use stable internal labels for tables, figures, appendices, and supplements.
  • Ensure generated bookmarks and reading order match the visible structure.
Raw lines 39 to 46
47## Typography and layout
49- Use the venue's prescribed font, spacing, margins, page size, and line numbering.
50- Do not use color, weight, or position as the only carrier of meaning.
51- Keep equations, symbols, units, subscripts, and superscripts intact through
52 conversion.
53- Check widows, orphans, clipped content, broken links, and misplaced floats manually.

Typography and layout

  • Use the venue's prescribed font, spacing, margins, page size, and line numbering.
  • Do not use color, weight, or position as the only carrier of meaning.
  • Keep equations, symbols, units, subscripts, and superscripts intact through conversion.
  • Check widows, orphans, clipped content, broken links, and misplaced floats manually.
Raw lines 47 to 54
55## Tables, figures, and accessibility
57Follow `figures_tables.md`. Verify alt text, captions, provenance, permissions, color
58independence, reading order, label legibility, and final-size rendering. Do not create a
59decorative visual simply to make a report appear complete.

Tables, figures, and accessibility

Follow figures_tables.md. Verify alt text, captions, provenance, permissions, color independence, reading order, label legibility, and final-size rendering. Do not create a decorative visual simply to make a report appear complete.

Raw lines 55 to 60
61## References and declarations
63References must render from verified metadata. After conversion, inspect identifier
64links, special characters, author order, and citation order.
66Declarations must come from validated records. A style template must never supply a
67default ethics approval, consent statement, funding source, conflict statement, author
68contribution, data or code promise, or AI disclosure.

References and declarations

References must render from verified metadata. After conversion, inspect identifier links, special characters, author order, and citation order.

Declarations must come from validated records. A style template must never supply a default ethics approval, consent statement, funding source, conflict statement, author contribution, data or code promise, or AI disclosure.

Raw lines 61 to 69
70## Archival handoff
72Retain:
74- the verified Markdown source;
75- the structured registries;
76- the exact venue template version;
77- conversion instructions and software versions;
78- the final rendered file;
79- validator outputs and human approval record.
81Do not archive sensitive source documents alongside a public manuscript package unless
82authorization, consent, law, contracts, and policy permit it.

Archival handoff

Retain:

  • the verified Markdown source;
  • the structured registries;
  • the exact venue template version;
  • conversion instructions and software versions;
  • the final rendered file;
  • validator outputs and human approval record.

Do not archive sensitive source documents alongside a public manuscript package unless authorization, consent, law, contracts, and policy permit it.

Raw lines 70 to 82