Document your code

Fossasia 2014

Who am I?

Remember

Everyone reads documentation

Why?

What you will see?

Who should do it?

Good examples in community?

Why? part2

What about code comments?

to write good comments you have to be a good writer.

-- Jeff Atwood

Some lines we heard from friends

What to document?

How?

reStructuredText tutorial

http://www.dgplug.org/irclogs/2012/rst-primer/

Host it online

http://readthedocs.org

Questions

?

Thank you

kushaldas@gmail.com

SpaceForward
Left, Down, Page DownNext slide
Right, Up, Page UpPrevious slide
POpen presenter console
HToggle this help