HOW TO MANAGE TECHNICAL DOCUMENTATION (not using confluence)
Вставка
- Опубліковано 17 вер 2024
- In this video I talk about managing documentation and what alternatives to the standard tools like Confluence I have used. Tools like GitBook www.gitbook.com/ (now a commercial product) have been a better fit for the engineering workflows in companies I worked for. I am recently experimenting with Docusaurus docusaurus.io/ that also seems very powerful and has the ability (via extensions) to generate docs in pdf format.
WHO AM I:
Hey friends, welcome to my UA-cam channel / outofdevops . If you're new here my name is Anto, here I talk about software engineering and software engineers. Don't forget to comment like and subscribe 👍🏻.
UA-cam GEAR:
🎥 My UA-cam Camera Gear - kit.co/outofde...
MY SOCIAL LINKs:
🐦 Twitter - / outofdevops
📘 Facebook - / outofdevops
📰 My blog - amasucci.com
📸 Instagram - / outofdevops
GET IN TOUCH:
If you’d like to talk, I’d love to hear from you. Tweeting @OutOfDevOps directly will be the quickest way to get a response, but if your question is very long, feel free to email me at hi@OutOfDevOps.com.
PS: Some of the links in this description are affiliate links that I get a kickback from 😜
Nice video Anto, looking forward to see more videos about Docusaurus 🙂
Thanks Piero, I have been working on something new. Hopefully it will be ready by September. Stay tuned!!! 😜
Great Video 🔥
Thanks Pradumna
Is there any gui based documentation tools which are opensource which i can install on pc ?
Docusaurus and mkdocs are good, but seems like a huge amount of work to write the actual documentation because of markdown language.
You can use a visual markdown editor. I use notion.so, it gives you the option to extract in markdown and can be installed as a standalone application on your PC. There are many alternatives another one is obsidian. A web alternative is hashnode.com/ you can use the web editor and you can copy the markdown once you are done.
How you handle non-technical documentation? For example, your marketing people. In my experience, they easily get scared when they should open a text editor, let alone IDE like VSCode, to edit markdown docs. So I'd like to have a good wysiwig editor for pages. Do you have something for that ?
The editor I am currently in love with for note taking, and non-technical documentation is notion (notion.so).
👋
Yo 👋🏼