Technical Writing 101 🇺🇦
1.6K subscribers
244 photos
3 videos
12 files
418 links
Anything's A Documentation If You're Brave Enough

👋 @SuckMyNuts
Download Telegram
medium_com_gsoft_tech_technically_writing_with_empathy_220da.pdf
1.6 MB
И мы снова в строю. 🎉

Немножко лёгкого пятничного чтива про эмпатию в документации. Простые, но правдивые прописные истины, не помешает лишний раз себе напомнить о важности юзера в нашей работе.

https://medium.com/gsoft-tech/technically-writing-with-empathy-220da8fff319

И если у вас, как и у меня, уже давно закончились халявные статьи на медиуме — ловите ПДФ-ку

#resource #voicetone #en
О том как быть более лучшим и добрым редактором.

Open Strategy Partners рассказывают и показывают на своем примере что такое Позитивный Подход при вычитке чужих работ.

Кроме самого посыла про более добрый и аккуратный подход к редактуре чужих текстов статья полна другими годными ссылками, например на внутренние Руководства по редактированию и видео про внутренние процессы редактуры.

🔗 Читать: The Positivity Pass and Why We Do It: Empathetic and constructive editing produces consistently better results and relationships over time.

#voicetone #en #resource
У New Relic довольно неплохой стайлгайд по написанию документации. Отдельно хочу обратить внимание на 5 вопросов, которые авторы стайлгайда предлагают задать себе, чтобы понять то ли ты вообще делаешь.

Следующая секция стайлгайда “Writing inclusive content” учит как не ненароком не обидеть своего читателя. Она довольно базовая, поэтому предлагаю взглянуть на отдельную статью про настройку своего линтера, которая помогает как раз находить такие узкие места в вашей документации.

Читать:
[1] New Relic Style Guide + 5 questions
[2] Reducing negative and biased language in documentation

#testthedocs #styleguide #voicetone #en #tool #language