Technical documentation writing quick tips (pinned)
An assortment of quick tips to help you make your technical documentation (docstrings, READMEs) easier to read.
Tech
Number of articles: 42.
Remove hard line breaks from READMEs
Hard line breaks in READMEs are common but not ideal. Let's try soft line breaks instead!
Setting up new developers for success: blog edition
New content based on my presentation "Setting up new developers for success".
Quick tip: Ignore commits in Git blame using a file
Ever wanted Git Blame to ignore your formatting commits? You can!
HTML link, or button, that is the question
Did you know that HTML links and buttons are not interchangeable? Learn more about their proper use cases in this article.
Quick tip: Formatting unordered lists in plain text
Tips on how to make plain text list items more readable.