Writing technical documentation - tutorial with Confluence
In this video, I explain to you why it's important to write good technical documentation and come up with some useful tips. I also will show you the tool Confluence from Atlassian which I use to write my technical documentation and how can you use it. #ITDocumentation #Confluence #HomeLab
Follow me:
TWITTER: / christianlempa
INSTAGRAM: / christianlempa
DISCORD: / discord
GITHUB: github.com/christianlempa
PATREON: / christianlempa
MY EQUIPMENT: kit.co/christianlempa
Timestamps:
00:00 - Introduction
01:23 - Why do we write technical documentation?
03:46 - Some tips on how to write good technical documentation
05:37 - What software and tools should you use?
08:46 - Confluence walkthrough
13:08 - Summary and Outro
----
All links with "*" are affiliate links.
I wish you had actually shown how to write documentation instead of explaining why you should write documentation. If you end up here, I think you already came to that conclusion.
Hi, thank you for so much for your feedback! I'm sorry that you're a bit upset about this, but it's an interesting idea for a second part or an example video about documenting a software project, business case, etc.
Many people don't know the importance of documentation, so this tutorial is excellent for that audience. A brief tutorial on how to write documentation is covered in this video and I found it useful. however, the documentation content should be with the respective domain expert :)
I was thinking the exact same thing.
@@christianlempa I needed this first. I would love a way of doing it. We have confluence cloud. I need to write a user guide for a Web application engineering tool that can be accessed on port 8080 from the core cluster nodes. There are so many aspects to it that I don't know if I should write one doc explaining applications. The a user guide explaining each module - jobs, transfer, core services separately. Then troubleshooting guide. So confused!!!
Thank you! I enjoyed it. We use Jira too
I realised this early on when trying to redo odoo installations. I decided to write a concise documentation and it definitely helps. Didnt know that I could include it as part of my resume though. 👍
This is exactly what I was looking for. Appreciate it fam! Just got my AWS job so it helps me alot
Awesome 😎👍 thank you bro!
I'm a Software Engineer and suck at- / don't like writing documentation. This video motivates me to give it the attention it needs. Thank you!
Thank you, that's great to hear! :)
Just finished a fully automated driver management utility for my job and yeah I agree with the statement that documentation is everything. I create quite a few documents (I've written almost 150 SOPs and troubleshooting guides for my job) but this video really drove why we do certain things while documenting home with me.
May I know what is the driver management utility that you use, please? thank you
@@rey6760 sorry cannot share it as it’s designed specifically for my environment
I knew there was a way to document, but didn't know exactly how, this was helpful
Thanks! Glad it helped you :)
Thank you for this amazing tutorial! I use Jira but was not aware of this Confluence!
Glad you liked it! :)
need more about this confluence topic, thx for this valuable knowledge
Thank you! :)
I will have to give confluence a try looks like something i have been missing. I normally use one note for all my documentation. i like how confluence has templates.
very helpful and looking for more content like this.
Hi Your video is really very helpful👍👍👍 Could you please make detail video on how to use all the features of confluence like adding link , inserting JIRA tickect ,inviting other people to edit the document.etc
Thank you! Well yeah maybe I'll do that in the future
Thanks for sharing this awesome tool
You're welcome :)
Schönes Video Meiner. Confluence hab ich gesucht. Danke für deine kurze Einführung.
Sehr gerne!
Christian ich bin gerade auf deinen Kanal gestoßen und klasse Videos! Man bekommt unglaublich viel Input für die kurze Zeit, aber es ist dennoch strukturiert und nicht zu schnell. Die meisten Videos scheitern genau an dem Punkt und neigen dazu "zu schlicht" oder "zu kompliziert" zu sein.
Vielen Dank! Freut mich sehr das zu hören :)
Thanks man! my problem is solved.
Very useful video thanks
Nice explain sir...thanks a lot🙏
You're welcome ;)
I m learning new things n side by side creating documentation in notepad++....I forgot there is tool for documentation 😅😅Thank you
amazing content, good luck
Thank you for the kind words ☺️
It's interesting need more content
very nice explanation :) thanks
Glad it was helpful!
You are the man!!!
Thx xD
Hi Christian! Thanks for creating this video. I learned new stuffs from it and for sure it will help me in my IT career. Surely I will share this to my colleagues. Two thumbs up! Cheers mate!🥰
At my current job, trying to explain this behavior of properly documenting the work done in a daily basis using Confluence with infographics, because they love to create huge text documents which nobody will ever read.
Hello Mr. Christian Lempa. Nice to watch your amazing and usefully video. I'm from Indonesia. I just interesting with tool that can make a good technical documentation which you explain above (Jira), but if we buy the license of that tool for my company it's too expensive than the other tools. Now in my company use a Click Up. I hope in the next video you can make a review how utilize the Click Up to make a good technical documentation for digital product or project. Thanks
Thanks! Honestly, I've tried to use ClickUp, but for me, it just didn't work well, as it's pretty slow and clunky :/
Great Sirrr
thanks bro :)
Thank you! It helped me get acquainted with the industry standard tools used for technical documentation. Stay safe :)
Thank you so much! :)
Sehr Sehr gut video mein bruder. Vielen dank!!
Gerne :D
Even with playback speed to 1.5x which comes down to near about 9:38, i felt like my time was robbed! Wish you could change the title to "should you write technical documents? Where do you start?"
This is not How To Write Technical Documentation. It’s just How to Navigate Technical Document management systems. Technically it’s not even a tutorial. It’s an introduction to Confluence.
Well, you could just make your own video and share your knowledge and experience with us. Would be great to have more Content on this topic 😉
Can you make a video about technical user manual
can you show us an example of complex tech docs?
Thank you
You're welcome
Don't forget you can always ask your Technical Writers, that's what we're here for!
That's right!
Thank you for this video) I'm a technical writer from Ukraine. We use Confluence and Jira in our company. I've written several guides for small applications we have - and I've met some problems. Firstly, I can't paste a small image directly to the text row - for example, images of buttons or marks. Secondly, I see no navigation tools on the page while editing - TOC appears only after publishing. So it's hard to make some kind of 300 pages user guide with one Confluence page, I need to add a new page for every chapter. But then I'll have to export all pages separately. So now I think Confluence is more useful for small documents - 30 pages or less. I'd love to read your advice - do I have to learn Confluence more, maybe I've missed something, or it's better to search for another documentation software? Thank you one more time) Have a good day)
Thank you for the great feedback! However, we're using confluence pretty well in our company, even for complex docs.
Do you have scroll documents installed? Are you using cloud confluence? I usually put images in tables with barely any outline, then you can put the text for the image in the second row. Just don't use a header for the table.
Have u tried notion?
I used to work at a company that used Confluence for their knowledgebase, I loved it so much that basically, every personal project I take on that requires a lot of documenting now goes into my own personal Confluence site. I also just started moving my current company's documentation from OneNote (yuck!) into Confluence for a beautiful and easy-to-navigate site for all help desk and new IT staff to easily troubleshoot common issues or to confirm policies or procedures. It's an amazing tool and I love when things are free because you're either a single person or have a really small team, that's a HUGE plus for me. I personally love technical documentation, just knowing that when I move on someone else will find what I wrote useful is amazing.
Oh I am envious. I find it so hard
need help with summary for Documenting the data analysis according to organisational
Sounds Amazing 👍, can you please share the sample document confluence links for (Userguide/Troubleshooting/Networking/Instruction guides) and how to maintain version control in confluence.
I don't have any sample documents, unfortunately
Cool..@@christianlempa
I just subbed because this was awesome. I needed something exactly like this.
Thank you :)
What exactly can confluence do what notion cant?
Please let me know next video for documentation
How to make flow chart
What things I have to mention in technical documentation for mobile application ?
Hi, I use bookstack for my documentation. I have hosted in the cloud.
Cool, that's also a nice way to do it
Is their any review and approval feature for document changes?
I guess that's included, as far as I know.
Scroll documents needs to be installed
-confluence,zira, and github
Please share some technical documentation for Production plant process
It's basically everything that a documentar already know.
What else would you like to know? :)
Hmm, I’ll just stick to OneNote 😂 It I would run an MSP it would be IT Glue or something self-hosted.
looks very similar to Notion
hm, usually I applaud your videos. A little bit disappointed of this one. The message after finishing the video is basically: You should use documentation. Think of a structure. Make it interessting. Just use an template import. First of all I don't think, that your last point and how you end the video matches the first three points. I was hoping for a video, in which you share best practices on software documentation. What structures worked and which did not work. Maybe especially in Confluence. My main paint point in confluence is, that I basically create "folders" with the sub pages, but most of the "folders" are then just empty pages, and the important content is in the "leafes" or the lowest pages. I would guess, that a reader would quickly get frustrated if he/she stumbles over too many white pages which only serve a structuring purpose. That and problems like it, I would have loved to see in this video.
I would not recommend Jira anymore. The product is EOL.
You didn't showed us how to write a technical documentation
like number 889.
Google doc
I don't like to leave a negative review but the title of this video is extremely misleading. I was expecting to see some actual workflow of creating technical documentation in Confluence but instead you offer some general wisdom, plus basic steps in Confluence that can be seen in another ten thousand videos across KZhead. Everyone can click on a template and if he's not entirely imbecile he'll understand the purpose of the content items almost immediately. What you can't figure out on your own is how to create a complex, cross-referenced, sturcured and printable, wiki-like documentation that can be used on entereprise level. That would be a proper tutorial. This is just clickbait and a waste of time.
Sorry you didn’t like it
@@christianlempa He is right! 15 minutes video, where "tutorial" part is about 5 minutes and half of this part is about creating account. Nice tutorial bro!
motivate 1 minute, explain 3 minutes, conclude 30 sec. Speak in terms of bullet points.
8 minutes 49 seconds before he gets into using confluence. Waste of time.
The background music is killing me bro, maybe make it really soft and something delightful
I’m sorry 🙈
Confluence is the most rubbish tool I have ever had to use. Literally every little thing I've set out to do in the documentation can't be done without a paid plugin, paid theme or by taking it off the cloud and running my own instance. I cannot believe this is "industry standard". Honestly, save your time and money, go download Redmine for free, host it, and install the Abacus Theme if you need it to look modern. What a waste of money and time confluence is. All marketing. No features. With paid gotcha's. Confluence users are fools. Of this you cannot change my mind.
I'm still trying to figure out what you mean by waste of money if you can use it for free?
@@christianlempa "...every little thing I've set out to do in the documentation can't be done without a paid plugin, paid theme or by taking it off the cloud and running my own instance..." We've settled on a very basic, clean document structure on the cloud, and the company is happy with that, which is great - but personally I won't ever use Confluence for my own projects. I find a free solution like Redmine much more powerful, useful and practical. Anyway, cheers for the video.
What is this??????????
Ruhig auf deutsch
Its not helpful why it was how to write what to write waste of time
I found this video as a waste of time. You could have wrapped this up in 30seconds or so. Thanks.
Blah blah
Useless