It does leave your flesh pockets awfully exposed
Has anyone told them they can probably use AI to search for opportunities for lawsuits?
How’s your back?
Hmmmm, I locked an open door…
Users are the acceptance testers.
No worries, sounds like you’re definitely on the right track with your approach.
In terms of the style of editor I don’t have a strong preference, I think the most important thing is discoverability which generally means putting docs where they are expected to be found and using whatever your team or org is using. Personally I have a slight preference for markdown mainly because it’s easy to version control, see who wrote what (so I can ask them questions) and use all the tools I’m used to that work well with plain text. Tools that use more WYSIWYG style can be good too though and many of them like Notion have the advantage of making it relatively easy to search across your entire companies documentation assuming everyone uses the one tool.
For my personal notes I use Logseq which I highly recommend. It’s a bit of both, markdown under the hood but with a simple editor that lets you focus on writing notes, tasks and links.
I would say as a new junior dev you are uniquely placed to help with this. Documentation tends to be written by people who know a lot about a thing and they try to imagine what might be useful for someone. Someone new coming in with a fresh perspective can help uncover assumed knowledge or missing leaps to make the documentation better. One of the common onboarding steps I’ve seen is to go back and update/improve the onboarding docs after you’ve just been onboarded for example.
I would say pick your battles though because documentation can be a never ending task and documents are almost always out of date shortly after they are written. Think about what would have saved you time or mental overhead if it was just written down and fix those first.
As far as organising and writing, every place is different and it can depend on the tools your org is using. In general I’d at least have links to relevant docs as close to where they might be needed as possible. Like how to set up and get up and running with a code base should probably be documented directly in the readme, or at least linked to if it’s overly complicated.
Hopefully that’s at least somewhat helpful. It’s definitely a problem basically everywhere I have worked though, you have to do what you can and not stress too much about it.
Oh wow, so it’s basically a content farm for /r/TheRightCantMeme
Government employee makes mistake, other employee corrects mistake, innocent family suffers minor inconvenience. Stay tuned for more.
Come on, we can’t replace him with something more competent
You should watch Johnny Got His Gun if you haven’t. Not quite as extreme but kind of similar theme.
This fucking guy. I hope he gets soundly defeated in November and I never have to hear or read about some dumb shit he said ever again.
Not meaningless, just flawed
No wait nevermind they were just between the couch cushions here. Haha that’s so funny I don’t know why I would assu- … wait… WHY IS THIS ON THE NEWS
Probably even one if the cat is facing the viewer
Just take 'em one at a time, you’ll be fine.
Actually it’s KotKit