Document Like a Scientist

A presentation at DevOpsDays Chicago in August 2019 in Chicago, IL, USA by Karissa Peth

Slide 1

Slide 1

Slide 2

Slide 2

Slide 3

Slide 3

Wow…. I miss scientific documentation

Slide 4

Slide 4

Slide 5

Slide 5

Slide 6

Slide 6

How is cancer research related to tech documentation?

Slide 7

Slide 7

Slide 8

Slide 8

Slide 9

Slide 9

Slide 10

Slide 10

Wow…. I miss scientific documentation

Slide 11

Slide 11

Slide 12

Slide 12

Slide 13

Slide 13

Slide 14

Slide 14

Slide 15

Slide 15

Determine the receptor(s) for the VISTA protein

Slide 16

Slide 16

Determine if VISTA protein binds certain types of cells Interrogate the differences between those cell types Run experiments to narrow down short list Run experiments to confirm receptor identity File patent & submit manuscript Screen develop anti-VISTA-R antibodies Confirm efficacy in cancer treatment

Slide 17

Slide 17

Slide 18

Slide 18

a Data what?

Slide 19

Slide 19

Slide 20

Slide 20

Slide 21

Slide 21

Data Sheet = Vendor Docs

Slide 22

Slide 22

Slide 23

Slide 23

Add density gradient medium to the tube by carefully pipetting it through the central hole. 2. Dilute sample with an equal volume of PBS + 2% FBS. Mix gently. 3. Add the diluted sample by pipetting it down the side of the tube. 4. Centrifuge at 1200 g for 10 minutes at room temperature with brake on. 5. Pour off the top layer, which contains the enriched MNCs, into a new tube. 6. Wash enriched MNCs with PBS + 2% FBS. Repeat wash.

Slide 24

Slide 24

Slide 25

Slide 25

Great documentation shifts your concentration from how to why

Slide 26

Slide 26

Slide 27

Slide 27

Slide 28

Slide 28

MATERIALS PBMC cultivation • RPMI 1640 medium • 100´ L-Glutamine stock solution (200 mM) • Human AB Serum • 24-well plate (e.g. Gas-permeable Culture Plate, # 150-000-362) ▲ Note: With the Gas-permeable Culture Plate (# 150-000-362), up to 2.5´107 PBMCs/well/mL can be stimulated as opposed to 1´107 PBMCs/well/mL in standard 24-well plates.

Slide 29

Slide 29

PREREQUISITES The following prerequisites are required for a successful and properly secured use of Helm. 1. A Kubernetes cluster 2. Deciding what security configurations to apply to your installation, if any 3. Installing and configuring Helm and Tiller, the cluster-side service.

Slide 30

Slide 30

Material Lists are the homework assignments for your docs.

Slide 31

Slide 31

Slide 32

Slide 32

Slide 33

Slide 33

Slide 34

Slide 34

Diagrams increase the accessibility of your docs.

Slide 35

Slide 35

Slide 36

Slide 36

Slide 37

Slide 37

Slide 38

Slide 38

Dates are a hint to users to expect differences between docs and real life.

Slide 39

Slide 39

Slide 40

Slide 40

Slide 41

Slide 41

Slide 42

Slide 42

Positive controls tell users they are heading the right way.

Slide 43

Slide 43

Rationale

Slide 44

Slide 44

Introduction Due to the very low frequency of ag-specific T cells in peripheral blood the reliable detection, enumeration and phenotypical characterization require the processing of high cell numbers and highly specific analysis methods. …. Combining magnetic cell enrichment and multiparameter flow cytometry analysis of CD154+ CD4+ T cells allow direct ex vivo detection and characterization of rare ag-specific T cells.

Slide 45

Slide 45

When to use them Heatmaps look best when you have a lot of events to visualize, and where the spread of values is wide enough to see some differentiation, but not complete noise. Any column representing a duration or size is a perfect fit, but any column you might run a percentile or average calculation on may benefit from being rendered as a heatmap as well.

Slide 46

Slide 46

Rationale in your docs creates lasting impact.

Slide 47

Slide 47

Wow…. I miss scientific documentation

Slide 48

Slide 48

Materials List Diagrams Dates Positive Controls Rationale/Uses

Slide 49

Slide 49

Great documentation shifts your concentration from how to why

Slide 50

Slide 50

Slide 51

Slide 51

Slide 52

Slide 52

Slide 53

Slide 53

https://giphy.com/gifs/computer-gif-artist-code-fedryX7dMGMe6lgqDm https://www.mskcc.org/car-cell-therapy https://www.mibioresearch.com/services/flow-cytometry/ https://stackoverflow.blog/2010/12/17/introducing-programmers-stackexchange-com/ http://www.agileo365.com/2019/03/Tracking-Agile-Progress-The-Sprint-Backlog.html https://blogs.technet.microsoft.com/yuridiogenes/2018/05/03/leveraging-azure-security-center-capabilities-in-a- pcidss-compliant-environment/ https://giphy.com/gifs/funny-flashback-12UtDavMK3xHmo https://twitter.com/ThePracticalDev/status/705825638851149824 https://dev.to/rly https://cdn.stemcell.com/media/files/pis/DX20655-PIS_1_1_0.pdf?_ga=2.213533332.1481748328.15666712161695496037.1566341450 https://www.miltenyibiotec.com/_Resources/Persistent/49ab790c21d8e328d07679dc66205cba48357cd7/SP_Rapid_ARTE.pdf https://helm.sh/docs/using_helm/#prerequisites https://learn.hashicorp.com/terraform?track=azure#azure https://docs.microsoft.com/en-us/azure/functions/tutorial-static-website-serverless-api-with-database-old https://www.miltenyibiotec.com/US-en/resources/macs-handbook/human-cells-and-organs/human-cell-types/cd4-t-cellshuman.html https://docs.microsoft.com/en-us/azure/aks/virtual-nodes-cli?view=azure-cli-latest https://docs.honeycomb.io/working-with-your-data/heatmaps/#when-to-use-them https://docs.microsoft.com/en-us/azure/functions/tutorial-static-website-serverless-api-with-database-old?tutorialstep=1 https://commons.wikimedia.org/wiki/File:PC3_prostate_cancer_cells,_confocal_image,_63x.jpg https://blogs.biomedcentral.com/on-medicine/2016/05/27/winners-breast-cancer-research-image-competition-2016/