529
How I, a non-developer, read the tutorial you, a developer, wrote for me, a beginner - annie's blog (anniemueller.com)
submitted 1 year ago by to c/programmer_humor@programming.dev
152 comments fedilink hide all child comments
you are viewing a single comment's thread
view the rest of the comments
[–] 13 points 1 year ago (4 children)

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!

  • permalink
  • fedilink
  • source
  • parent
  • hideshow 4 child comments
    •
  • [–] [S] 4 points 1 year ago

    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!).

  • permalink
  • fedilink
  • source
  • parent
  • [–] 3 points 1 year 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

  • permalink
  • fedilink
  • source
  • parent
  • [–] 1 point 1 year 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.

  • permalink
  • fedilink
  • source
  • parent