Clean Docs

A session at eurucamp 2012

Saturday 18th August, 2012

6:45pm to 7:00pm (CET)

A lot of the principles of clean code are forgotten when writing documentation.

Have a single source of truth and don't repeat yourself. Avoid writing brittle code. Use ubiquitous terminology and choose searchable names. Be consistent in your formatting. Test your code. Refactor and practise successive refinement. Don't write any more than you need to.

These principles of clean code can be applied with great effect to the production and maintenance of documentation, but there's more to it than that. Code needs to satisfy machines and coders. Documentation needs to satisfy people who perform a range of different tasks: from cursory inspection through to intensive development.

This talk will review relevant principles and examine real-world examples, leaving you with a practical mental checklist for writing documentation that will help your users and your software thrive.

About the speaker

This person is speaking at this event.
Chris Berkhout

Sign in to add slides, notes or videos to this session

eurucamp 2012

Germany Germany, Berlin

17th19th August 2012

Tell your friends!

When

Time 6:45pm7:00pm CET

Date Sat 18th August 2012

Short URL

lanyrd.com/sxbbh

Official event site

2012.eurucamp.org

View the schedule

Share

See something wrong?

Report an issue with this session