DEV Community

0 seconds of 13 minutes, 31 secondsVolume 90%
Press shift question mark to access a list of keyboard shortcuts
00:00
00:00
13:31
 
Jonathan
Jonathan

Posted on

4 1

Documentation tips for developers

As a follow-up to my last video, I wanted to share some tips on writing good documentation, based on my own experience.

Summary of the tips:

✔️ Keep articles short
✔️ Cover one main concept per article
✔️ Use every name of the concept
✔️ If more than one person asks, write about it
✔️ Collaborate! Make it a team effort
✔️ Use plenty of examples
✔️ Use screenshots
✔️ Use simple diagrams
✔️ No read/write controls
✔️ Link to documentation from tasks, chat messages, etc.

Top comments (1)

Collapse
 
djangotricks profile image
Aidas Bendoraitis

Thanks for the tips. I enjoyed them a lot. Hopefully they will make my docs clearer and more user friendly.

A Workflow Copilot. Tailored to You.

Pieces.app image

Our desktop app, with its intelligent copilot, streamlines coding by generating snippets, extracting code from screenshots, and accelerating problem-solving.

Read the docs