Why do developers love clean code but hate writing documentation?
It's time to delegate to the robots.
It's time to delegate to the robots.
Fabrizio Ferri-Benedetti, who spent many years as a technical writer for Splunk and New Relic, joins Ben and Ryan for a conversation about the evolving role of documentation in software development. They explore how documentation can (and should) be integrated with code, the importance of quality control, and the hurdles to maintaining up-to-date documentation. Plus: Why technical writers shouldn’t be afraid of LLMs.
Absent a time machine, telling others how to avoid my mistakes is the best I can do.
We chat with Jared Bhatti and Zachary Sarah Corleissen, two technical writers with deep experience at major tech companies and open source projects, about their approach to documentation and the new book they helped co-author, Doc For Devs.
When your open-source project starts getting contributors, it can feel great! But as a project grows, contributors can neglect to document everything.
All too often, developers go deep on the wrong things, when writing documentation. A little bit of empathy can get your docs back on track.
If there is one thing developers like less than writing documentation, it's responding to unnecessary escalations.
In an effort to rethink how documentation works, we recently introduced Articles, longer-form prose that can sit side by side with shorter Q&A.
When you're documenting anything technical, it's easy to forget what it's like being ignorant of how the software works, especially if you built the thing.