Hmmmm, I locked an open door…
Hmmmm, I locked an open door…
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
You should watch Johnny Got His Gun if you haven’t. Not quite as extreme but kind of similar theme.
Probably even one if the cat is facing the viewer
Just take 'em one at a time, you’ll be fine.
I hope they finally launch it officially, it’s been such a long time. I’m mostly hopeful that if they do launch the Steam Deck then they might also launch future hardware as well without such a big delay.
Maybe there’s a good argument for nonviolence but “the means dictate the ends” isn’t it imo. It could be that there’s more to it in the book but presented as is I’d say it doesn’t follow logically, I’m going to want to see proof that it’s actually true which is going to be tricky because there are obvious counter examples.
The easiest one is probably Ukraine. I’m sure most Ukrainians want to live in a peaceful and nonviolent society, but if they took your principle to heart there would be no Ukraine right now.
In Australia government funding is distributed to political parties based on the number of first preference votes they get as well so even if your first choice doesn’t get in, you still helped them by putting them first.
That’s pretty metal
I seem to remember one of the GTA games (maybe San Andreas?) had a stand up set from I think Ricky Gervais as something that would play on the TVs.
If you’re still worried, just avoid practicing solo.
A few years ago deciding I actually didn’t owe my dad my participation in our relationship.
I dunno, it’s already pretty good at writing code and only going to get better. I agree with your conclusion though, mainly because as a software engineer writing code is actually not even the most complicated part of the job. If an AI could write perfect code every time it’d make my job a lot easier but I’d still have to do a significant amount of work such as:
That’s just off the top of my head, I’m sure I’ve missed some things. As much as I love writing code I honestly feel like if an AI could do that part it’d just take stress out of my day and give me more time to focus on those other parts of the job. Of course in reality more work would probably just be piled on but that’s just life I guess.
True, in those cases it might not even enter your conscience thought and just happen automatically.
Lol indeed. Well this has been fun, you have a particularly delicious lack of self awareness that I always appreciate in these sorts of discussions so I look forward to seeing your next very helpful and clever contribution in future threads.
Have fun!
How’s your back?