documentation
페이지 정보
본문
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.
Confluence: https://atlassian.com/
BLOG ARTICLE: https://www.the-digital-life.com/en/writing-technical-documentation-tutorial
________________
BECOME A MEMBER AND BE A CODE HERO!
️ Get Help \u0026 Chat: https://discord.com/invite/bz2SN7d
Support me: https://www.youtube.com/channel/UCZNhwA1B5YqiY1nLzmM0ZRg/join
________________
AWESOME COURSES \u0026 TRAINING:
ITProTV-*: https://itpro.tv/thedigitallife
________________
HOST YOUR APPS \u0026 SERVERS:
DigitalOcean-*: https://m.do.co/c/e9f31a8c7756
________________
FOLLOW ME EVERYWHERE:
Twitter News: https://twitter.com/christian_tdl
Instagram Vlog: https://instagram.com/christian_tdl
GitHub Projects: https://github.com/xcad2k
Gaming and Coding: https://twitch.tv/The_Digital_Life_
Read my Blog: https://www.the-digital-life.com
________________
OTHER COOL STUFF:
️ My Equipment: https://kit.co/thedigitallife
Geek Merch: https://the-digital-life-store.creator-spring.com/
________________
⏱️ 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.
HEWfunkingKNEWit : 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.
Kevin Waithaka : This is exactly what I was looking for. Appreciate it fam!
Just got my AWS job so it helps me alot
The Mind Healer : Thank you for this amazing tutorial! I use Jira but was not aware of this Confluence!
Martijn Hartlief : 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.
Mason : 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.
Writing effective documentation | Beth Aitman | #LeadDevBerlin
Video sponsor: BuildKite (https://buildkite.com/)
Documentation can make a big difference. Internal documentation can speed your team up and makes it easier for new engineers to get up and running. External documentation reduces time spent on support questions, and makes your product more usable.
But we often don't get round to writing documentation, because it's kind of a pain, and we don't know where to begin. So in this talk, I'll give a primer on writing effective documentation, and on helping your team to write docs too. Covering:
What makes documentation useful
How to make it easier to get started
How to make writing clear and readable
About Beth Aitman
Beth Aitman is a technical writer at Google, where she works to improve developer experience for Site Reliability Engineers. She’s interested in the intersection between UX and writing, and is passionate about teaching developers to write good docs. Outside of work, she likes to run around, climb rocks, and solve cryptic crosswords.
Find out more: https://berlin2019.theleaddeveloper.com/talks#beth-aitman
Lead Dev is a community for technical leaders. We have a series of conferences and meetups designed with the needs and pain points of technical team leads in mind. We programme each conference around our three key themes of Team, Tech \u0026 Tools. The talks are designed to help very practically with common problems in these areas. To find out more about us, visit:
https://theleaddeveloper.com/
E : Great speaker, loved the clean layouts of her slides, the simplicity is so elegant.
Doda Garcia : This was so useful!! I have always ignored documentation (aside from inconsistent comments in the code) because I'm typically the only user, but I've recently realized that when you only use a piece of software every few months, you might as well be a total stranger to it because you have to relearn how all of it works each time.
This inspired me to document the API so that I don't have that extra friction next time I have to use the code. Thank you Beth!
Rusheb Shah : 1:05 start with what the reader needs
2:26 write less
4:05 write the outline first
5:19 rubber ducking
6:26 write readably
8:41 it's not just about documentation
Nivasan Babu Srinivasan : Beautifully explained, I loved the point about friendly documentation!
Cthuloo X : @Beth Aitman This was a great video on this subject. I learned a lot. Thanks!
Osterinsel Dokumentation [Documentation about Easter Island|German]
Infos über die Osterinsel / Infos about Easter Island:
Deutsch: http://de.wikipedia.org/wiki/Osterinsel
English: http://en.wikipedia.org/wiki/Easter_Island
Espanol: http://es.wikipedia.org/wiki/Isla_de_Pascua
Steffen311 : 1:00 weiß jemand, ob es die Musik im Hintergrund irgendwie einzeln gibt? Oder wurde die extra für Terra X gemacht?
Marzelmusik : *facepalm* schonmal was von Astronomie gehört?^^
Capt Bernd : Vor einigen Jahren gab es in Spanien ein Palmensterben, das durch einen Käfer bzw. dessen Made verursacht wurde. Das ging relativ schnell. Zum Schluß blieb nur der Stamm der Palmen übrig
samantha lyons : NOOO ITS IN GERMAN, AND I HAVE 44 MINUTES TO COMPLETE AN EASTER ISLAND DOCUMENTATION PROJECT.. NOOO
Lucky1337 : Es ist 2 Uhr Morgens. Ich muss in 4 Stunden aufstehen, ich könnte schwören,dass ich mir vor 5 Minuten noch ASMR Videos angekuckt habe :/ RIP Schlaf.
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.
Confluence: https://atlassian.com/
BLOG ARTICLE: https://www.the-digital-life.com/en/writing-technical-documentation-tutorial
________________
BECOME A MEMBER AND BE A CODE HERO!
️ Get Help \u0026 Chat: https://discord.com/invite/bz2SN7d
Support me: https://www.youtube.com/channel/UCZNhwA1B5YqiY1nLzmM0ZRg/join
________________
AWESOME COURSES \u0026 TRAINING:
ITProTV-*: https://itpro.tv/thedigitallife
________________
HOST YOUR APPS \u0026 SERVERS:
DigitalOcean-*: https://m.do.co/c/e9f31a8c7756
________________
FOLLOW ME EVERYWHERE:
Twitter News: https://twitter.com/christian_tdl
Instagram Vlog: https://instagram.com/christian_tdl
GitHub Projects: https://github.com/xcad2k
Gaming and Coding: https://twitch.tv/The_Digital_Life_
Read my Blog: https://www.the-digital-life.com
________________
OTHER COOL STUFF:
️ My Equipment: https://kit.co/thedigitallife
Geek Merch: https://the-digital-life-store.creator-spring.com/
________________
⏱️ 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.
HEWfunkingKNEWit : 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.
Kevin Waithaka : This is exactly what I was looking for. Appreciate it fam!
Just got my AWS job so it helps me alot
The Mind Healer : Thank you for this amazing tutorial! I use Jira but was not aware of this Confluence!
Martijn Hartlief : 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.
Mason : 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.
Writing effective documentation | Beth Aitman | #LeadDevBerlin
Video sponsor: BuildKite (https://buildkite.com/)
Documentation can make a big difference. Internal documentation can speed your team up and makes it easier for new engineers to get up and running. External documentation reduces time spent on support questions, and makes your product more usable.
But we often don't get round to writing documentation, because it's kind of a pain, and we don't know where to begin. So in this talk, I'll give a primer on writing effective documentation, and on helping your team to write docs too. Covering:
What makes documentation useful
How to make it easier to get started
How to make writing clear and readable
About Beth Aitman
Beth Aitman is a technical writer at Google, where she works to improve developer experience for Site Reliability Engineers. She’s interested in the intersection between UX and writing, and is passionate about teaching developers to write good docs. Outside of work, she likes to run around, climb rocks, and solve cryptic crosswords.
Find out more: https://berlin2019.theleaddeveloper.com/talks#beth-aitman
Lead Dev is a community for technical leaders. We have a series of conferences and meetups designed with the needs and pain points of technical team leads in mind. We programme each conference around our three key themes of Team, Tech \u0026 Tools. The talks are designed to help very practically with common problems in these areas. To find out more about us, visit:
https://theleaddeveloper.com/
E : Great speaker, loved the clean layouts of her slides, the simplicity is so elegant.
Doda Garcia : This was so useful!! I have always ignored documentation (aside from inconsistent comments in the code) because I'm typically the only user, but I've recently realized that when you only use a piece of software every few months, you might as well be a total stranger to it because you have to relearn how all of it works each time.
This inspired me to document the API so that I don't have that extra friction next time I have to use the code. Thank you Beth!
Rusheb Shah : 1:05 start with what the reader needs
2:26 write less
4:05 write the outline first
5:19 rubber ducking
6:26 write readably
8:41 it's not just about documentation
Nivasan Babu Srinivasan : Beautifully explained, I loved the point about friendly documentation!
Cthuloo X : @Beth Aitman This was a great video on this subject. I learned a lot. Thanks!
Osterinsel Dokumentation [Documentation about Easter Island|German]
Infos über die Osterinsel / Infos about Easter Island:
Deutsch: http://de.wikipedia.org/wiki/Osterinsel
English: http://en.wikipedia.org/wiki/Easter_Island
Espanol: http://es.wikipedia.org/wiki/Isla_de_Pascua
Steffen311 : 1:00 weiß jemand, ob es die Musik im Hintergrund irgendwie einzeln gibt? Oder wurde die extra für Terra X gemacht?
Marzelmusik : *facepalm* schonmal was von Astronomie gehört?^^
Capt Bernd : Vor einigen Jahren gab es in Spanien ein Palmensterben, das durch einen Käfer bzw. dessen Made verursacht wurde. Das ging relativ schnell. Zum Schluß blieb nur der Stamm der Palmen übrig
samantha lyons : NOOO ITS IN GERMAN, AND I HAVE 44 MINUTES TO COMPLETE AN EASTER ISLAND DOCUMENTATION PROJECT.. NOOO
Lucky1337 : Es ist 2 Uhr Morgens. Ich muss in 4 Stunden aufstehen, ich könnte schwören,dass ich mir vor 5 Minuten noch ASMR Videos angekuckt habe :/ RIP Schlaf.
... 
댓글목록
등록된 댓글이 없습니다.
