loading...
Cover image for Code Pixel - Write better documentation

Code Pixel - Write better documentation

valentinprgnd profile image Valentin Prugnaud 🦊 (he / him) ・1 min read

1 - Stay simple

Alt Text

We all want to add every single detail in our documentation. But sometimes, less is more. Get straight to the point.

2 - Avoid patronizing vocabulary

Alt Text

“It’s super easy”… Yet, if your users are struggling to follow the steps in your documentation, that can make them feel bad and give up. Avoid patronizing language in your documentation as much as you can.

3 - Make it searchable

Alt Text

If your documentation is a standalone site, make it searchable. Tools like Algolia allow you to implement a search engine on your site with a few steps.

4 - Be polyglot

Alt Text

If you can, display the code snippets in multiple languages, relevant to your users.


You can also find these pixels on my Instagram: https://instagram.com/valentinprgnd. I will publish Pixels every Monday, Wednesday, and Friday about career development in tech, code, mental health and health for developers. Follow me for more tips @valentinprngd and check out my podcast https://rebased.whatdafox.com.

Posted on by:

valentinprgnd profile

Valentin Prugnaud 🦊 (he / him)

@valentinprgnd

🦊 Writing/Speaking about tech stuff on whatdafox.com 🐻 Co-Founder/CTO at Speakbox 🚀 Co-Founder/CTO at Variate 🤓 Software Engineer

Discussion

pic
Editor guide