DEV Community

Cover image for 5 Tips For Writing Technical Documentation That Developers Love

5 Tips For Writing Technical Documentation That Developers Love

Pieces 🌟 on March 08, 2024

After I finished writing a blog post on Dev.to, I decided to schedule it to be published the next day. I received the message, "This URL is public ...
Collapse
 
thomasbnt profile image
Thomas Bnt β˜•

Hello ! Don't hesitate to put colors on your codeblock like this example for have to have a better understanding of your code 😎

console.log('Hello world!');
Enter fullscreen mode Exit fullscreen mode

Example of how to add colors and syntax in codeblocks*

You have also a error with your post

Image description

Collapse
 
get_pieces profile image
Pieces 🌟

Love this tip. Thank you.

Collapse
 
thomasbnt profile image
Thomas Bnt β˜•

Glad you liked!

Collapse
 
cbid2 profile image
Christine Belzie
Collapse
 
thomasbnt profile image
Thomas Bnt β˜•

Also a good post, thanks @cbid2 !

Collapse
 
michaeltharrington profile image
Michael Tharrington

Loving this! So much good advice here. πŸ™Œ

Collapse
 
get_pieces profile image
Pieces 🌟

Happy you enjoyed this! πŸ₯°

Collapse
 
cbid2 profile image
Christine Belzie • Edited

Thanks for giving me the opportunity to write this article @get_pieces! :)

Collapse
 
get_pieces profile image
Pieces 🌟

Thanks for sharing your knowledge. ☺️