Техническая документация, инструменты и профессия — независимый журнал
TECHWRITERS.ORG

Стандарты

Стандарты, терминология, доступность и повторяемые правила качества.

Доступные примеры кода и таблицы в технической документации
Стандарты

Доступные примеры кода и таблицы в технической документации

Доступность в документации не заканчивается навигацией и контрастом. Примеры кода, JSON-ответы, справочные таблицы и поясняющие иллюстрации тоже должны оставаться понятными, считываемыми и полезными без опоры только на цвет.

Термины и определения
Стандарты

Термины и определения

Глоссарий становится полезным, когда управляет решениями в продукте, интерфейсе и документации, а не просто собирает слова. Полезная терминологическая запись отвечает не только на вопрос «что означает слово?».

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

Правила структурированного письма, которые работают при сотнях авторов

Согласованность в масштабе создают контент-модели, терминология и повторяемые паттерны, а не просьба выучить огромный style guide. Важные правила нужно кодировать в схемах и компонентах. Небольшая команда может держаться на общих привычках и прямой редактуре.

Редакционный гайд, которым люди действительно пользуются
Стандарты

Редакционный гайд, которым люди действительно пользуются

Полезный style guide быстро решает повторяющиеся редакционные вопросы и не пытается сохранить каждое предпочтение, которое команда когда-либо обсуждала. Добавляйте правило, когда авторы регулярно сталкиваются с одним решением и несогласованность действительно мешает.

Редакционная техническая иллюстрация к статье: WCAG 2.2 для команды документации: с чего начинать на практике.
Стандарты

WCAG 2.2 для команды документации: с чего начинать на практике

Доступность — не только задача frontend. Авторы контролируют заголовки, смысл ссылок, alt-тексты, таблицы, инструкции и структуру, на которую опираются вспомогательные технологии. Тема сайта может обеспечить хороший контраст и работу клавиатуры, но понятность контента всё равно зависит от автора.