6

Writing user documentation is still such a boring part of the job :((

Comments
  • 6
    My manager just uses LLMs to write all the docs and README ... so they're mostly wrong, over-verbose and essentially useless.

    Am I the only one who likes writing documentation? Just keep it minimal. Put in the important things a developer needs to know.
  • 2
    @djsumdog Oh no, I do think writing documentation to other developers is fine (less boring tho). Just the documentation that the end user might use is just such a pain in the ass. I guess the support department usually does that but we don't have that :')
  • 4
    And the best. Especially 6 months later when a dev says "Ugg...this code is awful...worst I've ever seen...there isn't one drop of documentation!"

    Then I send a link to the wiki (and the link is usually in the class header) that explains every detail of the API code (some of the 'whats' and *a lot* of the 'whys'), you know 100% they are thinking "Drats! You win again PaperTrail ...next time ..victory will be MINE!"
  • 0
    @djsumdog haha, would be totally fine by me if the company would do that. Yolo. As long I don't have to do it :P Yes, you're the only one that likes writing docs :P
  • 1
    @djsumdog i don't like writting docs, but agree that using LLM produces such garbage i rather do it myself

    even with prompt for directing the LLM personality towards a non-verbose technical writter it still produces low-quality output while not really conveying the underlying ideas

    i get it - it was trained on beletry and loves using colorful language. but ffs, i need docs, not a novel
Add Comment