Sciware

Sciware: Documentation

America/New_York
3rd floor auditorium (162)

3rd floor auditorium

162

Description

How to Win Users and Influence Science

This Sciware will provide an overview of and practical solutions for creating user-facing documentation, helping users understand how to start using your software. We will cover various types of documentation (API, narrative, examples), how to write it (markdown, rst, docstrings), how to build it (jekyll, sphinx, doxygen), and places to host it (github, readthedocs, your own server).

Zoom link is available via email sciware@flatironinstitute.org or the #sciware slack channel. 

View slides