LibGuides: Code Sharing: Writing code documentation

The Grand Unified System of Documentation

The Documentation System There is a secret that needs to be understood in order to write good software documentation: there isn’t one thing called documentation, there are four. They are: tutorials, how-to guides, technical reference and explanation. They represent four different purposes or functions, and require four different approaches to their creation. Understanding the implications of this will help improve most documentation - often immensely.
A beginner’s guide to writing documentation
How To Write Better Code Documentation as a Beginner
The easiest way to create a README - readme.so

Using comments well

Comments should be concise and updated. Leaving comments out of place, outdated, or redundant makes the code harder to read. Likewise, don't leave "commented-out" code in. Once it's replaced, use version control to document the change and delete the old code. Leaving commented-out code in, again, can confuse readers and make it unclear what is supposed to be run.