https://infogalactic.com/info/Documentation

Any tips for documenting software or other things in life?

Examples of good or bad docs?

It seems like an overlooked but important topic in software and other things in life (like creating user manuals, etc.)

Thoughts on documentation in general?

  • Nerd02@lemmy.basedcount.comM
    link
    fedilink
    English
    arrow-up
    2
    arrow-down
    1
    ·
    9 months ago

    Yeah, it’s tough. From my experience, documentation is one of those thigns that you learn as you go, hard to have someone explain it to you.

    From my experience I found that powerpoints are a decent way of documenting coding work, especially at a broader level. If you need to get specific you probably just need to start typing walls of text, but if possible that should be avoided.

    As for documenting other things in life… well good question. Ikd if the same best practices that go for coding also apply there.