What all should good document contain ->
Things like
- Description
- Installation/Examples
Prerequistes
actualsteps
challenges - Supported versions
- Known Issues/Limitation
- Contribution
- Licenses
Third party libraries/tools with good docs with example on how to do => users tend to consume and contribute to this.
If not available, we may not use the library or switch to library with good doc or write our document for library with no document.
Do not assume the end user would know it.
choosealicense.com => to pick license
function test() {
console.log("look ma’, no spaces");
}
function test() {
console.log("look ma’, no spaces");
}