An Engineer’s Best Tips for Writing Documentation Devs Love

3 years ago thenewstack.io

Summary: This is a summary of an article originally published by The New Stack. Read the full original article here →

It’s fun to watch an enthusiastic speaker sharing what they’ve learned. And at the https://us.pycon.org/2022/ earlier this year that speaker was https://github.com/MasonEgger, an engineer turned lead developer advocate at https://gretel.ai/, a platform offering synthetic /privacy-protecting data. Prior to Gretel, Egger was a developer advocate and community author at https://www.digitalocean.com/, where, he told the audience, “I learned a lot of everything I’m about to teach you today.”

"I spent more time being afraid of acronyms, and not using tech because of the acronyms," Egger told the audience with a laugh.

https://www.codot.gov/business/grants/safetygrants/assets/APStyleGuideCheatSheet.pdf, Egger advises also writing out the full name the first time an acronym is used.

DevOps Articles