Research Documentation

Use when a repository produces measurements, benchmarks or experiments that need writing up as research rather than as a guide, or when any document in it has to be authored in LaTeX and compiled to PDF. What counts as research and what does not, the docs/research layout, the shape of a study document, the evidence rules (every number traceable, reproduction stated as a command, validate the instrument before trusting its readings, negative results get written up), when a study graduates to a LaTeX paper or a Beamer deck, how a non-study document borrows the house style without claiming to be research, how Mermaid diagrams reach a PDF from a single source, how a second language edition is published, and the shape of the GitHub Actions workflow that builds any of them. Bundled assets: the study template, the paper template and the Beamer theme.

konradcinkusz Updated

File contents

konradcinkusz/architecture-standards/tree/main/plugins/research-standards/skills/research-documentation commit 8588100f0f

Frequently asked questions

npx skillmds@latest add konradcinkusz/research-documentation