Такой вам daily reminder об инвалидах:

Если вы технический писатель, значит наверняка вы любите помогать людям, но смею напомнить, что не все люди одинаково функционируют. Незрячим людям очень поможет ваш писательский талант. Пара советов по написаниют alt text к картинкам:

https://medium.com/@amyalexandraleak/should-you-use-alt-text-or-a-caption-48311e259ded


P.S Напоминаю, что в Markdown alt text задается в таком формате .

Всем здоровых глаз 👀

#accessibility #article #en

Еще немного про инклюзивность (слепота, дислексия, новые пользователи продукта, не-нейтив спикеры) и вот это вот всё.

Гайд с подсказками как сделать жизнь вышеупомянутых групп меньшинств немножечко проще:

Оглавление:

— Как писать так, чтобы незрячие люди могли воспринимать вашу писанину с устойств для чтения с экрана;
— Как писать простым языком;
— Как подготовиться к переводу продукта;
— Как писать с оглядкой на ЦА;

#accessibility #en

Ну и чеклист по всем этим делам ;)

#checklist #accessibility #en

Небольшая подборка гайдов o том, как создавать доступный (в плане Accessible) контент:


Google: https://developers.google.com/style/accessibility

Microsoft: https://docs.microsoft.com/en-us/style-guide/accessibility/accessibility-guidelines-requirements

IBM: https://www.ibm.com/developerworks/library/styleguidelines/index.html

Wikipedia: https://en.wikipedia.org/wiki/Wikipedia:Manual_of_Style/Accessibility

У Web AIM есть хорошие статьи для изучения аксессебилити в вебе в целом: https://webaim.org/

#accessibility #article #styleguide #en

Это последний пост на тему "как начать писать, что такое техрайтинг" и вообще о каких-либо базовых вещах, связанных с написанием документации. Больше никаких вступительных курсов и базовых хендбуков, в канале достаточно информации, чтобы узнать, что это за профессия такая. Нам всем пора двигаться дальше.

Я постараюсь сконцентрироваться на более технических вещах или лингвистических. Больше про стратегии, SSG, линтеры, инклюзивность, a11y, information architecture, и намного меньше про базу.

Я уже когда-то кидал сюда этот хендбук, но уж очень он хорош в качестве введения, смело отправляйте вопрошающим "как вкатиться, что надо уметь" и всякое такое:

https://www.dozuki.com/hubfs/PDFs/Dozuki_Tech_Writing_Handbook.pdf

#career #en #SSG #accessibility

Daily Reminder:

Содержите вашу документацию “доступной” для людей с ограниченными возможностями.

Вот как раз для этого есть более-менее полный чеклист с основными штуками, про которые не стоит забывать

#accessibility #checklist #en

Наткнулся на на очередной инклюзивной писанины пост и подумалось мне, что это примерно то же самое, что я читал в предыдущей сотне статей про inclusive language.

Редакторскому составу этого блога данная тема кажется неинтересной и довольно простой, пускай она сейчас и актуальна 🏳️‍🌈 . Вот список слов которые обижают людей в 2020 году, вот список слов которыми их заменить, ну и как бы на этом все. 🤷

Собственно вопрос, постить что-то по этой теме или нет?

#accessibility #en #article

👅 Языки:

#ru | #en

👷 Карьера:

#career — советы и всемозможные статьи о карьере техписателя
#conference — техписательские конференции, их записи и заметки
#resources — ресурс для саморазвития
#article — полезная статья, которая учит чему-то клёвому, что позволит стать более лучшим писателем
#vacancy — интересная вакансия или что-то связанное с наймом
#video — видео, видос, видосичек, видосюлька. И подкасты!
#book — книга/хендбук
#courses — курсы, программы для технических писателей

🛠 Технологии:

#tool — полезная утилита/приложение
#changelog — все о чейнджлогах, примеры, правила
#markdown — все о языке разметки Markdown
#reStructuredText — все о языке разметки reStructuredText
#asciidoc — все о языке разметки asciidoc
#LaTeX — все систему набора и вёрстки и язык разметки LaTeX
#ide — среды разработки и все что с ними связано
#vscode — все о Visual Studio Code, настройка, плагины, хитрости
#SSG — JAMStack, генераторы статических сайтов, Hugo, Jekyll, Antora, etc.
#testthedocs — тестирование документации, линтинг
#API — про документирование API, примеры, лайфхаки, подсказки
#diagram — про диаграммы (много про diagrams as a code), mermaid, UML
#screenshot — все про скриншоты, утилиты, сервисы и красивенькие фотоснимки экрана
#ai — про GPT, GitHub Copilot и прочее, где ИИ помогает нам писать

🧺 Общее:

#tonevoice — о правилах общения в документации
#language — что-то конкретно о языке, в основном английский
#legal — юридическая документация, лицензии
#styleguide — все о стилях и правилах
#DocsAsCode — все про подход к документации как к коду
#example — примеры документации (хорошие и плохие)
#uiux — интерфейсы, текст в интерфейсах, пользовательский опыт
#knowledgemanagement — менеджмент знаний, хранилища, тулзы, техники, советы и наблюдения
#versioning — про версионирование
#accessibility — все об аксессебилити в документации
#checklist — чеклист/шпаргалка
#vintage — винтажная документация, старые компьютеры, софт, техника, игры
#visual — про визуальную составляющую документации
#metrics — все о метриках документации
#random — что-то совсем косвенно относящееся к техписательству, юморески

Предлагайте новые хэштеги в комментариях!