Hacker News new | ask | show | jobs
by x2tyfi 358 days ago
Undoubtedly a big opportunity area for LLMs. I’ve recently observed engineers deliver LLM-generated (or iterated) docs that blow away any technical writing they had done in the past.

Network Engineering design docs can be somewhat formulaic structurally, making the LLMs job simpler. I imagine in the near future we’ll just ask them to follow doc templates or reference other designs within a RAG system to ensure there aren’t gaps in the doc, etc.

3 comments

I'm not sure about that. For whatever reason, I've noticed that my brain has a hard time holding onto ideas from LLM-written documentation. Maybe because LLMs generate the mathematically lowest-energy thing that they can.

I'd take poor grammar and interesting ideas over clear grammar devoid of real content any day of the week.

Assuming that your ability to remember the content isn't a result of differences in the substance of the content, in my experience the stylistic issue can be addressed with thoughtful training/prompting and lots of Do/Don't examples.

It helps if your technical writers already adhere to a voice/tone guide, which can be pretty easily adapted/extended for automated documentation generation. If one doesn't exist, you'll definitely want to create that first. Some good examples:

Google: https://developers.google.com/style

IBM: https://ptgmedia.pearsoncmg.com/images/9780132101301/samplep...

Microsoft: https://learn.microsoft.com/en-us/style-guide/welcome/

Red Hat: https://stylepedia.net/style/

That’s understandable - the rule of “garbage in, garbage out” certainly still applies. I find that many engineers are capable of gathering the right requirements and content, but struggle with the polish/finish that makes docs more consumable - where LLMs can shine.
>Undoubtedly a big opportunity area for LLMs

Are you kidding me? This is the laziest, campiest, knee-jerk point I've run into in quite sometime.

I expect, as my co-workers expect of me, to learn and improve. Writing is a core part of engineering, and management.

I'd have some choice words for my co-worker (or vice-versa) if we just gave up and "ChatGpt'd our way to the top."

My goal is to be better than the LLM. :) As of now, it's a pretty low bar, I think.