Crafting Quality Product Documentation with Sofia Emelianova, Senior Technical Writer, Google
490 بار بازدید -
7 ماه پیش
-
In our latest episode of
In our latest episode of the Knowledgebase Ninjas podcast, Sofia Emelianova, Senior Technical Writer, at Google, talks about challenges technical writers face and techniques for crafting high-quality documentation.
𝐊𝐞𝐲 𝐓𝐚𝐤𝐞𝐚𝐰𝐚𝐲:
👉Sofia says the biggest challenge in a technical writing career is the curse of knowledge which comes with constantly gaining context on the thing that you are writing documentation on. When you're in context, your vision kind of blurs a bit. Hence, it's very difficult to put yourself in the shoes of the user.
👉Her solution is to seek out opportunities to get direct feedback from the reader of her documentation or her coworkers who are out of context to read her documentation and see if it makes sense to them.
👉"Another challenge is the whole velocity of development. I'm the sole technical writer for the developer tools. Sometimes I get help from my peers at Google technical writers or vendors. However, when I'm doing it on my own, I must improve the pace of my context switching to keep up with everything.”
👉She adds that we can’t focus on several things at once, so what people perceive as multitasking is very rapid context switching.
👉“When it comes to creating quality documentation, my go-to person is always subject matter experts. To speed up and ease communication, I spent an hour researching the topic and compiling a set of questions for the subject matter experts." says Sofia.
Find out more episodes: https://document360.com/podcast/
Listen on Apple or Spotify
👉 Apple Podcast- https://apple.co/2Y2MUHg
👉 Spotify - https://spoti.fi/3h93Tzf
Request a Free Demo: https://bit.ly/DemoDocument360
14-day free trial: https://bit.ly/SignupDocument360
► Subscribe to http://bit.ly/Document360 for more updates.
► Find us on Facebook: Facebook: document360
► On LinkedIn: LinkedIn: document360
► On Twitter: Twitter: document360
#Productdocumentation #KnowledgebaseNinjasPodcast #technicalwritingpodcast #document360 #technicalwriting
𝐊𝐞𝐲 𝐓𝐚𝐤𝐞𝐚𝐰𝐚𝐲:
👉Sofia says the biggest challenge in a technical writing career is the curse of knowledge which comes with constantly gaining context on the thing that you are writing documentation on. When you're in context, your vision kind of blurs a bit. Hence, it's very difficult to put yourself in the shoes of the user.
👉Her solution is to seek out opportunities to get direct feedback from the reader of her documentation or her coworkers who are out of context to read her documentation and see if it makes sense to them.
👉"Another challenge is the whole velocity of development. I'm the sole technical writer for the developer tools. Sometimes I get help from my peers at Google technical writers or vendors. However, when I'm doing it on my own, I must improve the pace of my context switching to keep up with everything.”
👉She adds that we can’t focus on several things at once, so what people perceive as multitasking is very rapid context switching.
👉“When it comes to creating quality documentation, my go-to person is always subject matter experts. To speed up and ease communication, I spent an hour researching the topic and compiling a set of questions for the subject matter experts." says Sofia.
Find out more episodes: https://document360.com/podcast/
Listen on Apple or Spotify
👉 Apple Podcast- https://apple.co/2Y2MUHg
👉 Spotify - https://spoti.fi/3h93Tzf
Request a Free Demo: https://bit.ly/DemoDocument360
14-day free trial: https://bit.ly/SignupDocument360
► Subscribe to http://bit.ly/Document360 for more updates.
► Find us on Facebook: Facebook: document360
► On LinkedIn: LinkedIn: document360
► On Twitter: Twitter: document360
#Productdocumentation #KnowledgebaseNinjasPodcast #technicalwritingpodcast #document360 #technicalwriting
7 ماه پیش
در تاریخ 1402/09/13 منتشر شده
است.
490
بـار بازدید شده