Tip 2 - put the condition first
When an instruction is conditional, put the condition before the action to perform.
Blog
Tip 1 - "... if one does not already exist"
When instructing a reader to make a new file or folder, acknowledge that one might already exist.
50 Docs tips in 50 days
It’s 50 days until I turn 50! So I thought I’d celebrate with a different docs tip every day.
Developing Astro with Gitpod
From a 7 year-old Chromebook to an Android tablet to a Linux desktop… all my building with Astro is done in a cloud development environment thanks to Gitpod! No local development environment? No problem!
Stop writing docs. Start helping!
Good docs can be the difference between a happy, successful user of your project and … a happy, successful user of someone else’s project. But documentation is often a task left to people who don’t feel comfortable writing it. This talk presented at ViteConf 2023 presents a new way to think about “writing good docs” and some action items that will immediately improve any existing documentation… without doing any writing at all!
Toggle Comments
© 2021 - 2024 Sarah Rainsberger. Except where otherwise noted, and/or quoting external sources, the content of this site is licensed under CC BY-NC-SA 4.0 
