home.social

#softwaredocumentation — Public Fediverse posts

Live and recent posts from across the Fediverse tagged #softwaredocumentation, aggregated by home.social.

  1. "What happens when AI agents start relying on the same messy docs your team already struggles to search?

    Demetrios hops into a Waymo in San Francisco with Dave Nuñez, founder and CEO of Falconer and co-author of Documentation for Developers. They talk about why developers and agents need different things from docs, why agents sometimes skip up-to-date instructions, and how a stale internal document can contribute to a production incident.

    Dave shares how Stripe cut roughly 500,000 internal docs down to 5,000 worth maintaining. The conversation also covers how to capture the reasoning behind engineering decisions, when a diagram beats a wall of text, and who owns the fallout when an agent acts on bad information."

    home.mlops.community/public/vi

    #TechnicalWriting #Documentation #SoftwareDocumentation #AI #AIAgents #GenerativeAI #LLMs

  2. "We can have AI audit the documentation and do it at a scale that we never, ever could have afforded with human beings, where it’d be this massive number of people doing this extremely uninteresting work. We can now offload that to AI and have that higher confidence in the documentation. Personally, doing PR reviews and saying, my gosh, this person’s content is good, but they just have like forty-six typos in here, or the writing style is all future tense and I need to change it or whatever, being able to get away from that and just do the higher-level review and leave the nitpickiness to our AI pull request reviewer, that’s been huge in terms of productivity. And being able to have a little bit higher degree of confidence in the code samples that we create as well has been massive in terms of productivity.

    Being able to quickly generate something. I don’t know about you, and I’m not trying to dunk on them or something, but I haven’t used Postman in years at this point, and I used to use it all the time. The reason is that now you just tell AI, hey, hit every single one of these REST endpoints and make sure the return values correlate to what I have here.

    And so, is it turbocharging our productivity? I guess maybe, maybe not. But I look at it as, it lets us focus on higher-level things. It lets us worry less about those individual feature guides and worry more about the connective tissue of the documentation and how everything links together. It lets us focus really hard on use cases and users and supplemental content, maybe like videos and blog posts, as opposed to all of our time being spent trying to burn down our three-hundred-bug list and keep up with feature releases. It lets us offload some things and focus on, I want to call it more interesting work, but at least higher-level work."

    idratherbewriting.com/blog/doc

    #TechnicalWriting #SoftwareDocumentation #Markdown #DocsAsCode #AI #GenerativeAI #LLMs #Programming #SoftwareDevelopment

Share on Mastodon

Enter the server where you have an account.