this post was submitted on 23 Sep 2024
67 points (100.0% liked)
Programming
17408 readers
74 users here now
Welcome to the main community in programming.dev! Feel free to post anything relating to programming here!
Cross posting is strongly encouraged in the instance. If you feel your post or another person's post makes sense in another community cross post into it.
Hope you enjoy the instance!
Rules
Rules
- Follow the programming.dev instance rules
- Keep content related to programming in some way
- If you're posting long videos try to add in some form of tldr for those who don't want to watch videos
Wormhole
Follow the wormhole through a path of communities [email protected]
founded 1 year ago
MODERATORS
you are viewing a single comment's thread
view the rest of the comments
view the rest of the comments
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.