• 0 Posts
  • 68 Comments
Joined 1 year ago
cake
Cake day: June 14th, 2023

help-circle
  • 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.



  • Wow that is pretty damning. I hope Google is adding all this stuff in with the replacement of Assistant but it’s Google so I guess they won’t. I replaced Assistant with Gemini a while back but I only use it for super basic stuff like setting timers so I didn’t realise it was this bad.

    They did the same shit with Google Now, rolled it into Assistant but it was nowhere near as useful imo. Now we get yet another downgrade switching Assistant with Gemini.

    As I like to say, there’s nobody Google hates more than the people that love and use their products.





  • I don’t know, man. This sounds like some “the enemy is both strong and weak” BS to me. When they can’t build a HSR in California they are an unplanned economy but when I point out the cost of China’s flavour of government suddenly the US is a dictatorship?

    I’ve got no issues acknowledging when China does some good things but come on. I was rightfully making fun of the implication of your meme here and you come back with doublespeak. There’s really no need to pick a side and defend it at all costs, we can acknowledge the positive and negative things.