Рубрика «пользовательская документация»

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

DITA расшифровывается как Darwin Information Typing Architecture. Фактически это формат, основанный на Читать полностью »

В случае возникновения критической ошибки обновления:
1. Установите причину ошибки.
2. Устраните причину ошибки.

Документация Microsoft

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

Читать полностью »

Привет! Меня зовут Катя, я лидирую Gramax, open source-платформу для управления технической документацией.

О Gramax мы уже писали тут. В этой статье расскажу о Gramax Check — сервисе автоматических проверок текстов на базе LLM. По сути — нашей версии «Главреда», но с настраиваемыми правилами.

Кому будет полезна статья:

  • Техническим писателям — если хочется отказаться от рутинной работы.

  • Руководителям отделов контента и редакторам — чтобы ускорить выпуск документации и оптимизировать процессы.

  • Читать полностью »

В технической и пользовательской документации часто встречаются фразы с использованием страдательного залога. Параметры там «задаются», файлы «сохраняются», а программа «запускается». Ох, опасная эта форма для строгих и однозначных описаний!

Почему же страдательный залог заставляет читателей страдать? Давайте разбираться.

Вопрос стоял об уплотнении

Вопрос стоял об уплотнении

Читать полностью »

Часть первая

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

Приятного чтения.

Читать полностью »


https://ajax.googleapis.com/ajax/libs/jquery/3.4.1/jquery.min.js