Home
Categories
EXPLORE
True Crime
Comedy
Society & Culture
Business
News
Sports
TV & Film
About Us
Contact Us
Copyright
© 2024 PodJoint
Podjoint Logo
US
00:00 / 00:00
Sign in

or

Don't have an account?
Sign up
Forgot password
https://is1-ssl.mzstatic.com/image/thumb/Podcasts221/v4/1d/86/f0/1d86f0f7-82da-708d-1c83-ea96ffdc81c3/mza_9501676357800704308.jpg/600x600bb.jpg
Writing Tech Brief By HackerNoon
HackerNoon
158 episodes
1 week ago
Learn the latest writing updates in the tech world.
Show more...
Language Learning
Education,
Technology
RSS
All content for Writing Tech Brief By HackerNoon is the property of HackerNoon and is served directly from their servers with no modification, redirects, or rehosting. The podcast is not affiliated with or endorsed by Podjoint in any way.
Learn the latest writing updates in the tech world.
Show more...
Language Learning
Education,
Technology
https://img.transistor.fm/ExU6UyvcNUy5x1WWCL3fu1U2C5nNaH5owjCoQ4nW_Ec/rs:fill:0:0:1/w:1400/h:1400/q:60/mb:500000/aHR0cHM6Ly9pbWct/dXBsb2FkLXByb2R1/Y3Rpb24udHJhbnNp/c3Rvci5mbS9lcGlz/b2RlLzE2OTcwMDYv/MTcwNTc2NjQ0Ny1h/cnR3b3JrLmpwZw.jpg
Common Mistakes in Engineer-Authored Docs and How to Fix Them
Writing Tech Brief By HackerNoon
7 minutes
1 year ago
Common Mistakes in Engineer-Authored Docs and How to Fix Them

This story was originally published on HackerNoon at: https://hackernoon.com/common-mistakes-in-engineer-authored-docs-and-how-to-fix-them.
How to fix these issues using the tools of the “docs-as-code” approach.
Check more stories related to writing at: https://hackernoon.com/c/writing. You can also check exclusive content about #documentation, #software-engineering, #technical-documentation, #docsascode, #ide, #tech-writing, #hackernoon-top-story, #programming, #hackernoon-tr, #hackernoon-ko, #hackernoon-de, #hackernoon-bn, and more.

This story was written by: @indrivetech. Learn more about this writer by checking @indrivetech's about page, and for more stories, please visit hackernoon.com.

Over the last six months, our development team has embraced the "docs-as-code" approach (you can learn more about our journey in this article). Regularly reviewing the documentation created by my colleagues from the Tech Division, I compiled a list of the most common issues found in writing technical documentation. In the article, I will show you how to fix these issues using the tools of the “docs-as-code” approach and not only. 

Writing Tech Brief By HackerNoon
Learn the latest writing updates in the tech world.