Best practices for technical documentation, whether they’re your company’s style guide or industry standards, may not always stand up to scrutiny in the wild.<\/b>
\nLet’s be friends:
Comment ( 0)
Join the DZone community and get the full member experience.
Kayce Basques, an awesome tech writer on our team, wrote up a pretty amazing article about his experiences measuring how well existing documentation best practices work for explaining technical material. „Best practices,“ in this sense, can be well-known industry standards for technical writing, or they could refer to your own company’s writing style guide.
Read full post .
While I am not a tech writer, my role involves a huge amount of engagement with our tech writing team as well as publishing a lot of „best practices“ for developers myself. I was amazed by how much depth and research Kayce has done on the art of writing modern docs through the lens of our team’s content. I fully encourage you to read Kayce’s article in-depth \u2014 I learned a lot. Thank you Kayce!
Comment ( 0)
Published at DZone with permission
of
Paul Kinlan
, DZone MVB. See the original article here.
Opinions expressed by DZone contributors are their own.<\/p>\n