this post was submitted on 12 Dec 2023
7 points (100.0% liked)

Based Count General Discussion

52 readers
1 users here now

Welcome to the Based Count General Discussion, a community where you can talk about anything and everything that is not covered by other communities on this instance.

For requests about the creation of new communities, head over to our stickied thread in [email protected].


Rules:

  1. No hateful content:
    while we highly value free speech, content explicitly targeted against users isn't tolerated. Sarcasm and edginess are accepted.
  2. Start a discussion:
    link posts should contain a few lines of context, your opinion on the matter or a TL;DR. Don't post naked links.
  3. Mark NSFW content; don't post porn:
    NSFW posts are allowed, as long as it's properly marked. However, porn is NOT allowed.
  4. No spam:
    Avoid repeatedly posting the same content or links already shared by others.

founded 1 year ago
MODERATORS
 

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?

you are viewing a single comment's thread
view the rest of the comments
[–] [email protected] 1 points 11 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.