2 ms·
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 ad
by CharlesW 1y ago
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 https://developers.google.com/style
IBM: https://ptgmedia.pearsoncmg.com/images/9780132101301/samplepages/0132101300.pdf https://ptgmedia.pearsoncmg.com/images/9780132101301/samplep...
Microsoft: https://learn.microsoft.com/en-us/style-guide/welcome/ https://learn.microsoft.com/en-us/style-guide/welcome/
Red Hat: https://stylepedia.net/style/ https://stylepedia.net/style/