Skip to content

konradcinkusz/research-standards

v2.0.0

How a repository documents scientific research, and how any document in the estate is authored so it compiles to PDF: the docs/research layout, the study document shape, the evidence rules, the house LaTeX preamble as a file every document \inputs, Beamer, diagrams called by slug, language and variant editions from one trunk, the LaTeX .gitignore, the CI build, and the templates and conformance check as bundled assets.

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 it, negative results get written up), when a study graduates to a LaTeX paper or a Beamer deck, why the house preamble is a file every document inputs rather than a block each one copies, how a non-study document borrows the house style, how Mermaid diagrams reach a PDF from one source and are called by slug, how language and variant editions come from one trunk, what a LaTeX .gitignore covers, the workflow that builds any of them, and the check that keeps it from drifting. Bundled: the study and paper templates, the house preamble, the Beamer theme and the check.

Read SKILL.md at the source

Pinned to revision 2396c4cb4d89, so it is the text this page describes rather than whatever the author pushed since.

Files

Every link opens the file at its source, pinned to the revision this page describes.