I think having good examples for each feature is really nice
this post was submitted on 12 Dec 2023
7 points (100.0% liked)
Based Count General Discussion
51 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:
- 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.
founded 1 year ago
MODERATORS
The golden rule is that all documentation is out of date. Trust but verify etc.
One thing I've seen a lot is having the version at the top of the page or a outdated mark. Very useful.
If you're writing, make sure you cover all the commands a user could run with your application. A good example for a command line app is explaining each command, its flags, and what they do. Similar to web apps with API endpoints, or the capabilities of any program with an UI. A good tool is VitePress. Both in documenting a tool and how to use it. Another good example for Developers is how Rust and Go offer documentation.
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.