PART 1 - WHAT IS IT, WHY USE IT, HOW DOES IT WORK?
Documentation is a critical part of any customer-facing product or service. Without it, your customers need hand-holding, your support staff struggles to help your users, and your company spends money on unhappy customers instead of creating new products.
One of the biggest challenges is creating quality documentation. Treating your documentation as part of your product leads the entire production team towards thinking of users first. Treating your documentation as part of your code lowers the barriers for your development teams to contribute.
In this talk, Michael Meyers (Managing Editor at Tag1) and Lynette Miles (Principal Technical Writer at Tag1) dig into what it means to treat your docs like code, and how it can help your teams’ workflows. We’ll also talk about linting - and why it can matter just as much for your writers as it does for your developers, and how a docs-as-code methodology can speed up contributions from everyone working on a product.
For a transcript of this video, see Transcript: Tag1 TeamTalk #027.1 Documentation as code: Part 1: A Linting How To - What, Why, and How?.
- Test the docs slack channel: #testthedocs
- Flesch-Kincaid readability score
- Hemingway Editor
- Drupalize.me - Joe Shindelar blog post featuring Vale