Documentation Guidelines
"Remember kids, the only difference between Science and screwing around is writing it down"
Alex Jason (made popular by Adam Savage)Screenshots
Redaction
Sensitive information should be redacted from screenshots used in documentation (unless you are very sure of the security controls in place to restrict access).
You should cut the information rather than just masking it.
If you must mask use solid blocks of colour, don't blur.
Use a lossless format like png rather than a lossy format like jpeg (jpeg compression artifacts can give enough clues to allow the redacted information to be identified).
If you use tools like Photoshop of GIMP to redact, be aware that the information may continue to exist in another layer. Export the redacted image to a flat (non-layered) file format (e.g . png) and securely delete any copies saved in layered formats.
See these links for further information...
Bibliography
https://practicaltypography.com/one-space-between-sentences.htmlhttps://www.hpe.com/us/en/insights/articles/how-to-write-documentation-thats-actually-useful-1707.htmlhttps://thevisualcommunicationguy.com/2014/07/01/18-rules-for-using-text/https://sibilaribeiro.com/create-your-website-color-palette/https://www.plainenglish.co.uk/how-to-write-in-plain-english.html
Iconshttps://www.pngrepo.com/https://www.pngrepo.com/collection/colored-brand-icons/https://github.com/kubernetes/community/tree/master/icons
Screenshotshttps://websetnet.net/best-tools-for-taking-and-editing-screenshots-in-linux/https://itsfoss.com/shutter-edit-button-disabled/https://security.stackexchange.com/questions/184099/secure-way-of-masking-out-sensitive-information-in-screenshotshttps://security.stackexchange.com/questions/126932/how-secure-is-blacking-out-sensitive-information-using-ms-paint
Creative Commonshttps://creativecommons.org/licenses/by-nc-sa/3.0/https://creativecommons.org/licenses/by-nc-sa/3.0/legalcode