Presentation Open Access

Let's Talk About Docs

Sick, Jonathan

What makes good software documentation? This doc shares what I've learned from being embedded with the documentarian community for one year. The talk covers why we document, the formal structures of software documentation (tutorials, conceptual guides, and API references), and how to approach writing for the web.

Files (7.1 MB)
Name Size
jsick_lets_talk_docs_LSST2016.pdf
md5:9c075cb1738ad41206209b02541552d2
7.1 MB Download
10
20
views
downloads
All versions This version
Views 1010
Downloads 2020
Data volume 141.2 MB141.2 MB
Unique views 1010
Unique downloads 1919

Share

Cite as