Technical documentation writing quick tips (pinned)
— TechAn assortment of quick tips to help you make your technical documentation (docstrings, READMEs) easier to read.
Number of articles: 6.
An assortment of quick tips to help you make your technical documentation (docstrings, READMEs) easier to read.
Check out the new version of my Table of Contents bookmarklet, remade by Zoë Bijl.
Tabs versus spaces; two spaces versus four; Windows versus Unix line endings: code editor settings differ per device and developer, which can be a hassle working in a team. There is an easy way to share base settings, and it's called EditorConfig.
Years ago, I built a bookmarklet to help me check heading structures on websites. This article links to the code on CodePen.
Sharing my philosophy and favorite tips and tricks on writing code documentation.
One of my web development pet peeves is the disregard for accessibility. In this article, I don't just explain why but give a couple of examples of disabilities that are not just deafness and blindness.