Learning to Program

10. Documentation

Note

Project: Use JSDoc and Grunt to create documentation for your kittenbook project.

I know what you’re thinking at this point: “Is he really going to make me read an entire chapter about writing documentation? If there’s anything more boring than writing documentation, it must be reading documentation, and if there’s anything more boring than reading documentation, it must be reading about writing documentation. I already know how to write comments in my code—how much more can there be?” Although I understand the sentiment, I hope you will soon see that documentation is not the programming equivalent of a VCR manual. Programming documentation is actually really cool. You can write notes about what you are doing right where ...