Skip to content

stevegrunwell/write-some-docs

master
Switch branches/tags
Code

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
css
 
 
js
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Still from the 1971 "I'd Like to Buy the World a Coke" advertising campaign I'd Like to Write the World Some Docs

It takes a special kind of person to enjoy writing documentation; not only do I have to write [ideally] working code, but now I have to write words that a human being can understand? What is this madness?!

Luckily, good documentation lives on outside your codebase. By following common documentation standards, we can generate comprehensive manuals that instruct others how to integrate with our software. After all, to code is human, but to document is divine.

View slides

Presentation History

Notes

  • Title slide background taken from the 'Hilltop' spot from Coca-Cola's 1971 "I'd Like to Buy the World a Coke" campaign.
  • "RTFM" design by Spreadshirt user t335
  • Westworld logo © 2016 Home Box Office, Inc