Rules to Better Technical Documentation

• Do you know all the cool stuff you can do on SSW Rules?
• Do you take a safety step before you delete content?
• Do you avoid duplicating content?
• Do you avoid using unnecessary words?
• Do you avoid the word "but" in your communication?
• Do you show 'Bad' and 'Good' examples when giving instructions?
• DRY - Do you avoid repeated elements in content?
• Do you know the best screenshot tools?
• Do you use screenshots instead of a 'Wall of Text'?
• Do you add branding to screenshots?
• Do you have a strong header and footer?
• Do you hide sensitive information?
• Do you put borders around white images?
• Do you distinguish keywords from surrounding content?
• Do you use the right character for replaceable text placeholders?
• Do you know to highlight the important information on a contract?
• Do you format quotations to stand out from the main text?
• Numbers - Do you use numbers digits instead of words?
• Numbers - Do you use separators to improve numbers' readability?
• Do you include abbreviated weekdays to dates?
• Do you know how to format addresses?
• Do you know the 3 types of dashes?
• On-page - Do you use descriptive links?
• Do you know to keep URLs clean?
• Do you know how to capitalize titles and headings?
• Do you know to capitalize tech terms correctly?
• Do you know "Scrum" (and other Scrum terms) should be capitalized?
• Do you know to always be careful with your spelling, grammar, and punctuation?
• Do you avoid common spelling and syntax mistakes?
• Do you avoid uncommon acronyms in your writing?
• Do you use "will", not "should" for processes?
• Do you use right terms for user authentication?
• Do you use "Try Again" instead of "Retry"?
• Do you know commas and full stops should have a single space after them?
• Do you know to use lowercase after "-"?
• Do you refer to the reader and author consistently throughout your document?
• Reference - Do you use the correct symbols when documenting instructions?
• Do you use emojis to help give context?
• Do you enhance readability with line breaks and spacing?
• Do you know how to format UI elements in technical documentation?
• Sample Names - Do you use generic and consistent names on examples?
• Do you make URLs short and readable?
• Do you know how to name documents/files?
• Do you have version numbers in documents and design files?
• Do you avoid using spaces in folder and file names?
• Do you document/update processes before sending "Done"?
• Do you produce the best End-User Documentation?
• Do you use Architectural Decision Records (ADRs)?
• Prefixes - Do you know why they are awesome?
• Do you know all the symbols on the keyboard?
• Do you know how to copy text from an image?
• Do you send links when offering support?