• ByteOnBikes@slrpnk.net
    link
    fedilink
    English
    arrow-up
    4
    ·
    edit-2
    5 months ago

    as a chronic documentation reader, the best advice i can give is to document everything Anything that the user can and will potentially interact with, should be extensively documented, including syntax and behavior.

    I don’t know about that. I’ve read some terrible documentation that had everything under the sun. Right now in the library I’m using, the documentation has every available class, every single method, what it’s purpose.

    But how to actually use the damn thing? I have to look up blog posts and videos. I actually found someone’s website that had notes about various features that are better than the docs.

    There’s a delicate balance of signal vs noise.

    • KillingTimeItself@lemmy.dbzer0.com
      cake
      link
      fedilink
      English
      arrow-up
      1
      ·
      5 months ago

      yeah, it also helps knowing how to use the thing, but i consider that to be “basic documentation” personally.

      Knowing how to set something up is nice, but knowing how to use it properly after setting it up is even nicer.