opensafely
Consolidate best practice documentation
We have several issues and discussions that relate to documenting best practice:
- #688
- #627
- #594
- #252
- #46
- #45
- #801
- #795
Currently, best practice is located under OpenSAFELY best practice in the menu. However, this is a pick-and-mix: from the manifesto to a study design, via Git. There is also a section on Programming tricks, although this relates to study definitions; and we have the discussion/Q&A forum.
It would be good to address these issues and to consolidate best practice documentation.
We should also document that adding log statements to scripted actions is useful. In a Python scripted action, that's as simple as calling print("...").
Document on writing/reviewing study definitions: https://docs.google.com/document/d/1ATd2ZUp0hOKHRNJ35pI7Aeo1Oq6stEEmBz4Mg_ds9kc/edit
Will has written https://github.com/opensafely/documentation/discussions/795, which we should also consider incorporating.
Helen's document on study definitions got mentioned in Slack, so I opened #801 to cover including it into the OpenSAFELY docs as a specific task (seeing as all the others here have individual issues).
