Document Like a Scientist

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

Learn how scientists document their work and are able to pick up new experimental protocols quickly. Apply the concepts of scientific protocols to your documentation to make them more useful to yourself and your users.

In this talk, I’ll discuss standard aspects of scientific documentation that allows scientists to pick up new experiment protocols with over 100 steps and execute them flawlessly. We’ll dive into the purpose of each piece of scientific documentation and how that translates to a better experience with technical documentation. These features don’t require writing more, but thinking about how the features of the documentation help not only the user but also the writer of the documentation.

Video

Buzz and feedback

Here’s what was said about this presentation on social media.