1087
Discord != Documentation
(lemmy.dbzer0.com)
you are viewing a single comment's thread
view the rest of the comments
view the rest of the comments
this post was submitted on 28 Jul 2023
1087 points (99.0% liked)
Programmer Humor
32568 readers
385 users here now
Post funny things about programming here! (Or just rant about your favourite programming language.)
Rules:
- Posts must be relevant to programming, programmers, or computer science.
- No NSFW content.
- Jokes must be in good taste. No hate speech, bigotry, etc.
founded 5 years ago
MODERATORS
I'm usually on the documenting side of things. If something like this starts unfolding, I produce text or HTML files anyway, they go on github/lab/whatever, and I wash my hands of what happens next.
In the end I write documentation mostly for myself. When the company can't figure things out over Discord or whatever ephemeral chat interface they use, I get called anyway.
> I produce text or HTML files anyway
I do extensive in-code documentation. The compiler discards all comments so I don't worry about commenting my code. Source code is for humans to understand and write anyways.
Oh, yeah. My source code is like 60% comments by weight (or more). Although I typically produce separate standalone documentation for management or semi-technical staff. You know, people who know enough to possibly break something, but not enough to fix it afterward. I find it useful when trying to train new people too.
User-facing documentation is a completely different thing, yes.
Also writing documentation in-code like JavaDoc or equivalents has always seemed great for me. Then you can have your toolchain generate the written documentation directly from that, and it can be updated easily based on what's actually documented in the code (but that does require that people keep that updated)