Published August 15, 2016 | Version v1
Presentation Open

Let's Talk About Docs

  • 1. LSST

Description

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

jsick_lets_talk_docs_LSST2016.pdf

Files (7.1 MB)

Name Size Download all
md5:9c075cb1738ad41206209b02541552d2
7.1 MB Preview Download