Size: a a a

Technical Writing 101

2019 January 26
Technical Writing 101
Как я уже не раз говорил, доля Техписа может занести вас совсем не в туда, куда вы себе представляли, когда устраивались на оную должность. Так, например, вас могут напрячь быть каким-нить UI Writer'ом и писать интерфейсные тексты окажется не так просто, как выглядело со стороны. Сегодня мы попробуем не забыть о том, что иногда продукты переводят и интерфейсные тексты — тоже:

https://blog.prototypr.io/3-things-to-keep-in-mind-when-designing-ui-to-be-translated-in-different-languages-e1d02accf21c
источник
2019 January 28
Technical Writing 101
Для любителей порисовать диаграмки в Mermaid:
https://sprite.link/
источник
2019 January 30
Technical Writing 101
Прекраснейшей информативности статья про Тултипы. Показывают c картинками Do's и Don't's, рассказывают в чем разница между Попап Типсами и Тултипсами и всякое такое!

https://www.nngroup.com/articles/tooltip-guidelines/


P.S Канал жив, а вот редакция едва ли. Гигантский загруз по работе, но я о вас не забыл, скоро разгребем всё и снова будем умнеть вместе
источник
Technical Writing 101
Тут выложили статистику (собранную с 71281 разработчика) с кучей всякой информации. Прошу обратить внимание на самую большую боль разработчиков — плохая документация.

https://research.hackerrank.com/developer-skills/2019
источник
2019 February 01
Technical Writing 101
источник
Technical Writing 101
Анастасия Степанова @anasta_ste поделилась своей статьей про ГОСТы по написанию документации:
https://docplace.ru/gost34/
источник
Technical Writing 101
Дмитрий Макаров написал, чем UX-писатель отличается от копирайтера.

— Пишет только в контексте интерфейса. Его текст помогает человеку понять, что изображено на картинке.
— Ограничен объёмом. Приходится буквально втискивать текст в строки и маленькие блоки. Сокращая текст, не имеет права терять смысл.
— Пишет в других форматах: кнопки, подписи, заголовки, пункты меню, подсказки, пояснительные тексты, таблицы, чекбоксы, радиокнопки.
— Не может специализироваться на определённых тематиках или продуктах. Обязан уметь быстро погружаться в новые темы и извлекать знания, чтобы писать предельно ясные формулировки.
— Думает, как пользователь будет взаимодействовать с интерфейсом. Текст помогает пользователю решить его задачи, уберегает от ошибок, предупреждает, что ждёт дальше, о чём-то напоминает.
— Работает в постоянном контакте с дизайнером. Чтобы написать текст, надо точно знать, как работает интерфейс.

https://sobakapav.ru/articles/ux-writer-difference
источник
Technical Writing 101
Переслано от Sergey Bronnikov
расписание докладов про документацию на FOSDEM https://fosdem.org/2019/schedule/track/tool_the_docs/, прямая трансляция https://fosdem.org/2019/schedule/streaming/
источник
2019 February 07
Technical Writing 101
technical_writing
Редко когда бывает, чтобы два абсолютно разных человечьих увлечения, а в моем случае это комиксы и документация (согласитесь, довольно далекие друг от друга понятия), тесно пересекались в какой-то одной штуке. Бросаю всё и спешу с вами поделиться великолепным! Скот МакКлауд (автор известнейших и даже изданных на русском «Понимание комикса», «Переизобретение комикса», «Создание комикса») в своей характерной пояснительно-разъяснительной манере учит понимать уже не комиксы, а контейнеризированные приложения используя Kubernetes. Это ге ни аль но, наслаждайтесь! Там даже внизу есть окошко терминала, в котором можно потренироваться крутить-вертеть все штуки которым собственно и учит эта дока. Нужно взять и положить эту страничку в палату мер и весов как эталонный пример документации.

https://cloud.google.com/kubernetes-engine/kubernetes-comic/
Еще один крутецкий пример Comics as Documentation, в этот раз об устройстве сервисов Amazon:

https://www.awsgeek.com/
источник
2019 February 08
Technical Writing 101
Наташа, редактор в UX Яндекс.Денег, хорошо рассказывает про процессы здоровой команды, умение задавать вопросы и здравый смысл. А ещё о том, что придумать название кнопки — только маленькая часть работы редактора интерфейса.
Желаю всем таких процессов.

https://m.habr.com/ru/company/yamoney/blog/439186/
источник
2019 February 11
Technical Writing 101
Когда у вас спросят "Что такое плохая документация?" можете смело показывать им эту картинку.
источник
2019 February 15
Technical Writing 101
Интересная подборка остроумных и смешных вырезок из *nix'овых man страничек

https://www.shellscript.sh/tips/man/
источник
2019 February 19
Technical Writing 101
Как писать грамотные Error месседжи:

https://uxplanet.org/how-to-write-the-perfect-error-message-ffc132fda06a
источник
2019 February 20
Technical Writing 101
>Цель этого документа - предложить целенаправленную, четко определенную и ориентированную на читателя модель для сбора значимой и действенной обратной связи для улучшения качества документации и повышения удовлетворенности читателя.

https://www.stc.org/techcomm/2019/02/04/beyond-accuracy-what-documentation-quality-means-to-readers/
источник
2019 February 21
Technical Writing 101
Всё ещё частенько пользуетесь Google Docs по долгу службы, но упёрто хотите больше Markdown'а в своей жизни и жизни вашей компании? Получите и распишитесь, конвертер Docs в Markdown:

https://github.com/evbacher/gd2md-html/wiki
источник
Technical Writing 101
Первая часть описывающая современный UX-райтинг тон в Microsoft. Как общаться с юзером и не звучать как робот:

https://medium.com/microsoft-design/microsoft-voice-principles-1-730f413190c1
источник
2019 February 26
Technical Writing 101
В Quora запустили такую штуку как Spaces. Spaces - курируемые разделы посвященные какой-то определенной тематике и ессесно там есть раздел про техническое писательство, подписываемся.

https://www.quora.com/q/oubhsvimfatejoew?ch=10&share=34ed2914
источник
2019 March 06
Technical Writing 101
Предлагаю ознакомиться с качественным экземпляром "нарративной документации", господин-программист Scott B. Weingart рассказывает о приключении одного, но очень смелого SMS-сообщения, от начала его набора, до момента отображения его на экране у получателя.

http://scottbot.net/the-route-of-a-text-message/

Нарративное техническое повествование это к.р.у.т.о, прекрасно подойдет на почитать в теплый вечер среды.
источник
2019 March 11
Technical Writing 101
>Компания Google анонсировала программу "Season of Docs", похожую на "Summer of Code", но нацеленную на подготовку документации для открытых проектов.

https://www.opennet.ru/opennews/art.shtml?num=50295
источник
2019 March 19
Technical Writing 101
Новых интересных статей не наблюдается, но вы держитесь. Тем временем нас почти 400 (!)
источник