Keep provenance visible
- Mark the source as synthetic in the filename, title and data dictionary.
- Describe how the records were generated or where the synthetic values came from.
- Do not attach invented institution names, participant identities or realistic identifiers.
- Retain the exact script or calculation steps used to create and analyse the example.
- Replace the example only with data you are authorized to use and have properly documented.
Describe output proportionately
For a synthetic example, explain only what the generated records show inside that example. Do not generalise to students, patients, customers or a location. If using real data, state the sampling, measurement, missingness and analysis limits needed to interpret the result, and follow consent, privacy and institutional approval conditions.
- Separate observed description from interpretation.
- Report the denominator, units and variable definitions.
- Do not describe statistical significance as practical importance.
- Keep unsuccessful or contradictory checks in the analysis record.
- Label example tables and figures as synthetic wherever they are reproduced.
Write a reproducible example paragraph
In the 40-record synthetic teaching file, the mean fictional quiz score is 65.975, and the Pearson correlation between the generated study-hours and score columns is 0.758. These summaries describe only the constructed example. No students were observed, and the calculation does not estimate a real educational relationship.
Those values are printed by the companion script and are included to show how to label a result, state its denominator and name the calculation. If the file or code changes, recalculate the output before reusing the numbers. Do not add a p-value, population statement or causal explanation unless the data and design support that analysis.
- Keep the raw input, analysis script and a short data dictionary together.
- Record any changed rows, recoding, exclusions or missing-value rules.
- State the software and version needed to reproduce the calculation.
- Check that tables and figures use the same data version and units.
- Label every copied output 'synthetic teaching example' and separate it from real study findings.
Sources and further reading
These university writing resources inform the general advice here. They do not replace your department's handbook or supervisor's guidance.
