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
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!
This was super helpful , I’m a platform PM & writing documents for a technical audience has been challenging I’m looking to grow an improve in this area.
swear to god, she's right. ive seen documentations with abundance in details but does not help much in achieving what i want which usually forces me to look immediately at a use case in a medium blog or something
Nice, but I prefer writing the documentation of the things I make myself with the other Sr. engineers. Never worked with a technical writer, maybe I see some significant difference if I try. Is there anyone think as same as me?
@@techne_ but isn't it doing a double job someone who doesn't make the app writing a documentation and they need to review the code line by line so they can understand and write the docs.
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
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!
Great speaker, loved the clean layouts of her slides, the simplicity is so elegant.
she writes good documentation, couldnt expect less
This was super helpful , I’m a platform PM & writing documents for a technical audience has been challenging I’m looking to grow an improve in this area.
swear to god, she's right. ive seen documentations with abundance in details but does not help much in achieving what i want which usually forces me to look immediately at a use case in a medium blog or something
This definitely helped in reflecting on my documentation styles and how to improve it.
Thank you!
Great talk! I love the last point. Often people try to mitigate the problem with documentation and don't try to solve the underlying problem
Straight to the point and simply explained ❤
Very good and structured description of base rules for creator of useful documentation
Beautifully explained, I loved the point about friendly documentation!
Thank you, I will use your technique to document my feature
great content and beautiful smile at the end
@Beth Aitman This was a great video on this subject. I learned a lot. Thanks!
Brilliant, thank you!
Does anyone have a sample doc like she explained here
Great concise talk!
Nice talk - good advice, especially 'write readably'
Does anyone know how to get a link to the blog she mentioned?
Anyone able to get the name of that blog?
Some great ideas.
Can you please help me know how to get Software documentation writer job as a fresher?
English is on different level mam
Nice, but I prefer writing the documentation of the things I make myself with the other Sr. engineers. Never worked with a technical writer, maybe I see some significant difference if I try. Is there anyone think as same as me?
Only great or huge enterprises hire technical documentation specialists.
@@techne_ but isn't it doing a double job someone who doesn't make the app writing a documentation and they need to review the code line by line so they can understand and write the docs.
Thank you!!!
Thanks! That was really effective 👍
Fabulous video
Nailed it!
Nice content, thanks.
this was really good
very informative
loved this ❤️
My english teacher send me here.
cool video thank ur teacher
kinda hot