29 subscribers
Go offline with the Player FM app!
Documentation as code: Part 1: A Linting How To - What, Why, and How? - Tag1 TeamTalk #027.1
Manage episode 282608945 series 2858510
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.
122 episodes
Manage episode 282608945 series 2858510
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.
122 episodes
All episodes
×
1 Navigating SOC 2:: Tag1's Journey to Attestaion 45:27

1 Improving Drupal CMS Performance with Gander: Real-World Wins and Lessons 35:36

1 Tag1 Drupal 7 Extended Support: Security Updates Post-EOL :: Tag1 Team Talk 17:00

1 Tag1 D7ES: Extending Drupal 7: CKEditor 5 Integration to Secure D7 Sites and Add Functionality 25:44

1 Learn more about: D7ES from Tag1 - Extended Support for Drupal 7 after EOL 25:25

1 Explore Drupal's Workspaces: A Game-Changer for Site-Wide Content Staging 35:54

1 Introducing: A Step-by-Step Guide for Migrating Data from D7 to D10 with Mauricio Dinarte:: Tag1 Team Talk 36:14

1 DDEV Local Development - Insights & Demo with Maintainer Randy Fay - Tag1 Team Talks 36:32

1 Shifting from FID to INP: Google’s New Metric for Improving Web Performance - Tag1 TeamTalk 30:16

1 Tag1 Team Talk: Gander Automated Performance Testing - Video Demo with Nat Catchpole 46:17

1 Moving from Drupal 7 to Drupal 10: Managing Complex File and Media Migrations - Tag1 Team Talks 1:00:47

1 Unraveling the Extract, Transform, Load ,(ETL) Data Migration Process: Taking a Deep Dive on Load 25:19

1 The Sustainable Web: Exploring Drupal’s Sustainability Project, Gander's Ability to Help, and How You Can Too. - Tag1 Team Talk 44:49

1 Unraveling the ETL Data Migration Process - Understanding Transform - Tag1 Team Talk 38:29

1 Unraveling the ETL Data Migration Process - Understanding Extract - Drupal Migration Series - Tag1 Team Talks 33:34
Welcome to Player FM!
Player FM is scanning the web for high-quality podcasts for you to enjoy right now. It's the best podcast app and works on Android, iPhone, and the web. Signup to sync subscriptions across devices.