Based Count General Discussion@lemmy.basedcount.comEnglish · 11 months ago

Documentation: Documenting All The Things

zeazide@lemmy.basedcount.com to

Based Count General Discussion@lemmy.basedcount.comEnglish · 11 months ago

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?

Chat

librecat@lemmy.basedcount.com
link
fedilink
English
arrow-up
3·
11 months ago
I think having good examples for each feature is really nice

Based Count General Discussion@lemmy.basedcount.com

general@lemmy.basedcount.com

Create a post

You are not logged in. However you can subscribe from another Fediverse account, for example Lemmy or Mastodon. To do this, paste the following into the search field of your instance: !general@lemmy.basedcount.com

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 !announcements@lemmy.basedcount.com.

Rules:

No hateful content:
while we highly value free speech, content explicitly targeted against users isn’t tolerated. Sarcasm and edginess are accepted.
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.
Mark NSFW content; don’t post porn:
NSFW posts are allowed, as long as it’s properly marked. However, porn is NOT allowed.
No spam:
Avoid repeatedly posting the same content or links already shared by others.

Visibility: Public

This community can be federated to other instances and be posted/commented in by their users.

1 user / day
1 user / week
1 user / month
1 user / 6 months
1 local subscriber
51 subscribers
34 Posts
38 Comments
Modlog