SuperAPI AI Directory

scientific-reporting

Frontend & websites

View repository

Updated 10-15 21:46

About this skill

Scientific Reporting

Pain points you encounter (why you need this skill)

Many "report-writing failures" are not about being unable to write, but rather:

  • Routing mistakenly goes to docs-media(hijacked by PDF/Word keywords)
  • The report has no structure (missing Executive Summary / reproducible Methods / traceable Results)
  • Figures and tables fall short (screenshots, low DPI, inconsistent fonts, color-unfriendly)

The responsibility of this skill is:Treat the report as a deliverable engineering artifact, and bring figures and narrative under the same specification.


Applicable scenarios (keywords)

  • Chinese:科研报告、技术报告、项目报告、实验报告、分析报告、HTML 报告、PDF 报告
  • English:technical report、research report、HTML report、Quarto、RMarkdown

Not applicable:

  • Only "extracting PDF text/parsing docx" → docs-media/pdf/docx/markitdown

Input (minimum information)

  1. Audience: boss/reviewer/client/group meeting peers (determines writing style and depth of explanation)
  2. Purpose: decision-making/reproduction/reporting/archiving (determines whether an appendix is required)
  3. Output format:Markdown / HTML / PDF(multiple selections allowed)
  4. Data and figures: whether data already exists, figures already exist, or figures need to be generated from data

Output (default directory)

Recommended output is (subdirectories can be created by project name):

  • reports/<topic>/report.md(source-of-truth)
  • reports/<topic>/report.html(optional)
  • reports/<topic>/report.pdf(optional)
  • reports/<topic>/figures/(figures cited by the report, sourced from figures/**/out)
  • reports/<topic>/appendix/(methods, parameters, environment, additional figures and tables)

Template:templates/report-skeleton.md


Workflow (mandatory order)

Phase 1 — Structure first (build the skeleton first)

The report must include (even if abbreviated):

  1. Executive Summary (conclusions first)
  2. Context (problem and constraints)
  3. Methods (reproducible: data/process/parameters)
  4. Results (figures as the skeleton)
  5. Discussion (explain significance, limitations, recommendations)
  6. Appendix (optional but recommended: environment/additional figures/tables)

Phase 2 — Anchor results with figures

  • Figures and tables go through scientific-visualization(publication-quality)
  • Diagrams go through scientific-schematics(process/mechanism/system diagrams)
  • Text explanation goes through scientific-writing(paragraph form, avoid bullets as the final draft)

Phase 3 — Export strategy (HTML/PDF)

If HTML is needed:

  • Preferred: Markdown + static figures (PDF/SVG/PNG)
  • If interactivity is needed: Plotly outputs HTML (and provide a static fallback)

If PDF is needed:

  • Key point: figure fonts and line widths must be readable in the final layout
  • Prohibited: treating webpage screenshots as PDF

Quality gates (before report delivery)

  • "Conclusions first": reading the Executive Summary tells you the key points and recommendations
  • "Reproducible": Methods + Appendix are sufficient to reproduce the key results
  • "Figures usable": unified fonts, colorblind-friendly, correct export formats
  • "Traceable": every conclusion can point to a certain figure/table/calculation