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.