Writing effective documentation | Beth Aitman |

[@rushebshah]

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

[@DodaGarcia]

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!

[@ErnestoCode]

Great speaker, loved the clean layouts of her slides, the simplicity is so elegant.

[@lucemanb8732]

she writes good documentation, couldnt expect less

[@ColbyCBoone]

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.

[@kresnofatihimani5073]

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

[@zenginellc]

This definitely helped in reflecting on my documentation styles and how to improve it.
Thank you!

[@n1gr082]

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

[@roland7599]

Straight to the point and simply explained ❤

[@taraspelenio8259]

Very good and structured description of base rules for creator of useful documentation

[@nivasanbabusrinivasan1086]

Beautifully explained, I loved the point about friendly documentation!

[@SamOween]

Thank you, I will use your technique to document my feature

[@hamedahmadi9291]

great content and beautiful smile at the end

[@cthuloox476]

@Beth Aitman This was a great video on this subject. I learned a lot. Thanks!

[@bob-the-constructors9912]

Brilliant, thank you!

[@mosesket]

Does anyone have a sample doc like she explained here

[@TheLegendSpeaker]

Great concise talk!

[@MainlyWebStuff]

Nice talk - good advice, especially 'write readably'

[@preciousonyewuchi5128]

Does anyone know how to get a link to the blog she mentioned?

[@raoulkoopman9408]

Anyone able to get the name of that blog?

[@TheNickzer]

Some great ideas.

[@Amy-zz5ln]

Can you please help me know how to get Software documentation writer job as a fresher?

[@sirimora750]

English is on different level mam

[@goktugerol1127]

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_]

Only great or huge enterprises hire technical documentation specialists.

[@goktugerol1127]

@@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.

[@tiagosilveira3334]

Thank you!!!

[@stronglonggg]

Thanks! That was really effective 👍

[@milo-hc9nk]

Fabulous video

[@smllmp]

Nailed it!

[@wattywhee2283]

Nice content, thanks.

[@Virus00000000000001]

this was really good

[@jgtb0pl]

very informative

[@wilhelmpaulm]

loved this ❤️

[@giancarloprado8206]

My english teacher send me here.

[@manaralsahli9143]

cool video thank ur teacher

[@JuriBinturong]

kinda hot