wcpowg
Last Updated: February 25, 2016
·
324
· aaronmccall

Writing documentation

Remember that the reader of documentation is not as familiar with the code as you, and also likely doesn't care about the intrinsic beauty of your lovely algorithms. The reader wants to know "What can this code do for me?" and "How do I make it do what I need it to do?" Write your documentation to answer the readers' questions, and both you and they will win!