Calgary, AB

Analytics Documentation: Best practices, Tips and guidelines

8 - Asteroid

EveryAll, in yesterday's user group this important topic was brought it up. And since this is vital step in ensuring reproducibility of our work, I think we all would benefit in hearing or seeing (if you are willing to share a workflow) how you document your analytics.


Here are some sub-topic ideas to spark the conversation:


1 - Naming convention (for workflows, files and fields)

2 – Annotations (Comment, tool container, tool annotation, formula comments)

3 – Use of colors

4 – Use of macros

5 – Fields clean-up

6 – External supporting documentation (like a read me file?)


If you are willing to contribute, I am willing to compile all the comments and create a quick guideline document for us to use and share.