ความคิดเห็น •

  • @rushebshah
    @rushebshah 3 ปีที่แล้ว +67

    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
    @DodaGarcia 3 ปีที่แล้ว +23

    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
    @ErnestoCode 4 ปีที่แล้ว +40

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

    • @lucemanb8732
      @lucemanb8732 3 ปีที่แล้ว +6

      she writes good documentation, couldnt expect less

  • @kresnofatihimani5073
    @kresnofatihimani5073 2 ปีที่แล้ว +2

    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

  • @ColbyCBoone
    @ColbyCBoone 6 หลายเดือนก่อน +1

    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.

  • @zenginellc
    @zenginellc 3 หลายเดือนก่อน

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

  • @n1gr082
    @n1gr082 4 ปีที่แล้ว +3

    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
    @roland7599 5 หลายเดือนก่อน

    Straight to the point and simply explained ❤

  • @EdwardSapp
    @EdwardSapp 14 วันที่ผ่านมา

    Wonderful, thank you!

  • @hamedahmadi9291
    @hamedahmadi9291 ปีที่แล้ว +1

    great content and beautiful smile at the end

  • @nivasanbabusrinivasan1086
    @nivasanbabusrinivasan1086 4 ปีที่แล้ว +1

    Beautifully explained, I loved the point about friendly documentation!

  • @taraspelenio8259
    @taraspelenio8259 4 ปีที่แล้ว +1

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

  • @SamOween
    @SamOween ปีที่แล้ว

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

  • @cthuloox476
    @cthuloox476 3 ปีที่แล้ว

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

  • @mosesket
    @mosesket 2 หลายเดือนก่อน

    Does anyone have a sample doc like she explained here

  • @MainlyWebStuff
    @MainlyWebStuff 3 ปีที่แล้ว

    Nice talk - good advice, especially 'write readably'

  • @preciousonyewuchi5128
    @preciousonyewuchi5128 2 ปีที่แล้ว

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

  • @TheLegendSpeaker
    @TheLegendSpeaker 3 ปีที่แล้ว +1

    Great concise talk!

  • @Amy-zz5ln
    @Amy-zz5ln 2 ปีที่แล้ว

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

  • @raoulkoopman9408
    @raoulkoopman9408 3 ปีที่แล้ว +1

    Anyone able to get the name of that blog?

  • @stronglonggg
    @stronglonggg 4 ปีที่แล้ว

    Thanks! That was really effective 👍

  • @goktugerol1127
    @goktugerol1127 ปีที่แล้ว +1

    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_
      @techne_ ปีที่แล้ว

      Only great or huge enterprises hire technical documentation specialists.

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

  • @TheNickzer
    @TheNickzer ปีที่แล้ว

    Some great ideas.

  • @sirimora750
    @sirimora750 ปีที่แล้ว

    English is on different level mam

  • @milo-hc9nk
    @milo-hc9nk 2 ปีที่แล้ว

    Fabulous video

  • @wattywhee2283
    @wattywhee2283 2 ปีที่แล้ว

    Nice content, thanks.

  • @tiagosilveira3334
    @tiagosilveira3334 2 ปีที่แล้ว

    Thank you!!!

  • @smllmp
    @smllmp 2 ปีที่แล้ว

    Nailed it!

  • @Virus00000000000001
    @Virus00000000000001 4 ปีที่แล้ว

    this was really good

  • @jgtb0pl
    @jgtb0pl 2 ปีที่แล้ว

    very informative

  • @wilhelmpaulm
    @wilhelmpaulm 4 ปีที่แล้ว

    loved this ❤️

  • @giancarloprado8206
    @giancarloprado8206 3 ปีที่แล้ว +1

    My english teacher send me here.

  • @banwa_non
    @banwa_non 3 หลายเดือนก่อน

    kinda hot

  • @bob-the-constructors9912
    @bob-the-constructors9912 10 หลายเดือนก่อน

    Brilliant, thank you!