{"type":"rich","version":"1.0","provider_name":"Transistor","provider_url":"https://transistor.fm","author_name":"Writing Tech Brief By HackerNoon","title":"Common Mistakes in Engineer-Authored Docs and How to Fix Them","html":"","width":"100%","height":180,"duration":434,"description":"\n This story was originally published on HackerNoon at: https://hackernoon.com/common-mistakes-in-engineer-authored-docs-and-how-to-fix-them.\n How to fix these issues using the tools of the “docs-as-code” approach. \n Check more stories related to writing at: https://hackernoon.com/c/writing.\n 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.\n \n \n This story was written by: @indrivetech. Learn more about this writer by checking @indrivetech's about page,\n and for more stories, please visit hackernoon.com.\n \n \n \n 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.\n\nIn the article, I will show you how to fix these issues using the tools of the “docs-as-code” approach and not only. \n \n ","thumbnail_url":"https://img.transistorcdn.com/LXiX31rrbwLw9J62kpK9WBDgYoaVWl0Q2rRKU2SJbyk/rs:fill:0:0:1/w:400/h:400/q:60/mb:500000/aHR0cHM6Ly9pbWct/dXBsb2FkLXByb2R1/Y3Rpb24udHJhbnNp/c3Rvci5mbS9zaG93/LzQxNDMwLzE2ODM1/ODM1MzMtYXJ0d29y/ay5qcGc.webp","thumbnail_width":300,"thumbnail_height":300}