• Flamekebab@piefed.social
    link
    fedilink
    English
    arrow-up
    12
    ·
    1 day ago

    On the flipside I’ve encountered docs that expect the reader to already understand the functionality in order to be able to use the docs. They seem to exist solely as a reminder to those who already know.

    There’s a reason I don’t bother running my own mailservers anymore!

    • BCsven@lemmy.ca
      link
      fedilink
      arrow-up
      3
      ·
      20 hours ago

      Yeah, I use a software that had amazing documentation when they had a publishing company division. When the publisher was gone the documentation is at most a glorified of glossary.

      Help on Feature XYZ: Feature XYZ allows you to use FeatureXYZ

    • fmstrat@lemmy.nowsci.com
      link
      fedilink
      English
      arrow-up
      3
      ·
      21 hours ago

      Oh man, this I do hate. If you have terminology in your app, that is not a standard, please, please define it.

    • They seem to exist solely as a reminder to those who already know

      Perfect description of the entire Microsoft .NET documentation, signed, .NET beginner who not only didn’t have a .NET background, but not even a Microsoft programming background (which is also heavily assumed throughout - way to make newbies feel completely unwelcome in your ecosystem!).

    • ZeroOne@lemmy.world
      link
      fedilink
      arrow-up
      1
      ·
      21 hours ago

      I found this website/article by accident on neocities, it’s about a tutorial Git. Though it’s a bit bare-bones I respect the effort.

      Would be nice to see what all of you think. Considering this is a thread on tutorials. I hope this kid succeeds in life.