|
|
|
|
|
by nrclark
366 days ago
|
|
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. |
|
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/