Рубрика «техническая документация»

Техпис против прокрастинации: как победить самого себя - 1

Привет! На связи команда Документерры — платформы для управления документацией. Вот и пятница, а значит, самое время поговорить о том, что мешает нам продуктивно завершать рабочую неделю. Все мы знаем, как важно успевать вовремя выполнять задачи, будь то написание Читать полностью »

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

источник: https://rusneb.ru/catalog/000199_000009_009238665/

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

Как писать об изменениях, если вам не всё равно - 1

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

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

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

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

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

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

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

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

Привет! Меня зовут Юрий Никулин, и я руководитель направления документирования Cloud. Сегодня расскажу, как мы перешли с документирования в Word на подход docs as code и почему в качестве языка разметки выбрали reStructuredText.

Создание системы документирования, или как мы от «ворда» к docs as code за месяц переходили - 1

Почему мы этим занялись

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

Всем привет!

Меня зовут Денисов Александр. Я работаю в компании Naumen и отвечаю за документирование и локализацию программного продукта Naumen Contact Center (NCC).

В этой статье расскажу о тех проблемах, с которыми мы сталкивались при локализации NCC на английский и немецкий языки и о том, как мы решали эти проблемы. Конечно, на сегодняшний день мы решили далеко не все свои задачи и, скорее всего, этот процесс вообще бесконечен. В статье рассматривается видение всего процесса в целом и те принципы, которым мы стараемся придерживаться или которые начинаем пробовать применять. Материал будет полезен тем, кто только начинает проектировать ПО, планирует его локализацию или уже сталкивается с проблемами, но пока не знает как их решить.

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

MS Word регулярно подкидывает нам «сюрпризы»: «съехавшие» скриншоты, «плывущие» таблицы, пустые страницы при печати. Эта статья о том, как мы искали замену MS Word, (спойлер — не нашли), а нашли возможность глобально улучшить наш процесс работы с документацией.

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


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