An Engineer's Field Guide to Great Technical Writing
The Stack Overflow Podcast
00:00
Do You Have a Style Guide for Documentation?
Zack: I think there's a really important value for accessibility of are we using words that every one agrees with and that makes to them and carry the same meaning? Ause it's very easy to overload words. We also document things in a style guide, so i know the linx foundation as a style guide. There's many other companies have great style guides that i refer people to. Having a consistent language and an agreement soron how that language is used is really important. Language needs to be as easily localizable as possible. So it means that colloquial understandings become like an anti pattern in documentation. Don't use things thatt don't really translate cross or outside
Transcript
Play full episode
