help wfrules: Rules for best practice in workflow

Basic rules for effective workflow

#: Provenance: The provenance of every result should be
documented.

#: Posting Principle: Once a file is posted, it should
never be changed. Never change a variable that has been posted.
Never share a file till it is posted.

#: Run order: Do-files should be named so that when run
in alphabetical order they exactly recreate your datasets
and/or replicate your analyses.

#: Basic backup: Make at least two, bit-verified backup copies;
store them in different locations.

#: Drukker's Dictum: Never type anything that you can obtain
from a saved result.

#: Long's Law: It is always faster to document it today
than tomorrow.

#: Label variables: Create a note and variable label
for all new variables. Categorical variables should have value labels.

#: Never final: Never name it final!

#: Test graphs: Alway try them before you present them.

#: datasignature: Use datasignature before saving a dataset;
check the signature when you load a dataset.

#: Getting help: The clearer and more detailed the information
you provide, the greater the chance you will get the help you need.

#: Too many files: It is easier to create a file than to
find a file; easier to find a file than to know what is
in the file; and it is tempting to create a lot of files.

Rules for replication

1: Backup and archive your dataset and do-files.

2: Keep a research log.

3: Document the provenance of all reported results.

4: Always set the seed when using random numbers (set seed #).

Also see

Workflow