Рубрика «техническая документация»
Как писать об изменениях, если вам не всё равно
2024-12-13 в 8:16, admin, рубрики: release notes, история изменений, техническая документация
Обучение и воркшопы: как виртуозно познакомить заказчика с новой функциональностью
2024-12-06 в 16:02, admin, рубрики: bercut, воркшоп, воркшопы, демонстрация, демонстрация новой функциональности, обучение, преподаватели в IT-компании, тестирование, техническая документация, функциональностьПредставьте, что вы — заказчик разработки новой функциональности. Это решение очень нужно вашему бизнесу, по всем расчётам оно поможет существенно увеличить прибыль и, возможно, опередить конкурентов. Вы долго уточняли и согласовывали техническое задание, и теперь очень хотите узнать, как действует готовое решение. Как его реализовали разработчики? Удобен ли интерфейс? Не пропустили ли какую-то важную деталь при согласовании требований?
Искусственный интеллект в документации: как внедрить бота-документоведа
2024-11-24 в 12:16, admin, рубрики: qa, документация, ИИ, нейросети, техническая документация, технический писатель, чат-бот, Чат-боты, чатбот, чатботы
«Кто на ком стоял?» Про страдательный залог в технической документации
2023-11-06 в 16:29, admin, рубрики: документация, мануал, однозначность, пассивный залог, пользовательская документация, страдательный залог, техническая документация, технические писатели, технические тексты, формулировкаВ технической и пользовательской документации часто встречаются фразы с использованием страдательного залога. Параметры там «задаются», файлы «сохраняются», а программа «запускается». Ох, опасная эта форма для строгих и однозначных описаний!
Почему же страдательный залог заставляет читателей страдать? Давайте разбираться.
Читать полностью »
Создание системы документирования, или как мы от «ворда» к docs as code за месяц переходили
2022-09-05 в 7:36, admin, рубрики: devops, reStructeredText, sphinx, Блог компании Cloud, Подготовка технической документации, справка, техническая документацияПривет! Меня зовут Юрий Никулин, и я руководитель направления документирования Cloud. Сегодня расскажу, как мы перешли с документирования в Word на подход docs as code и почему в качестве языка разметки выбрали reStructuredText.
Почему мы этим занялись
Принципы документирования и локализации, или как получить хорошую локализацию минимальными затратами
2019-11-01 в 10:43, admin, рубрики: l10n, localization, naumen, technical writing, Блог компании Naumen, локализация, Локализация продуктов, техническая документацияВсем привет!
Меня зовут Денисов Александр. Я работаю в компании Naumen и отвечаю за документирование и локализацию программного продукта Naumen Contact Center (NCC).
В этой статье расскажу о тех проблемах, с которыми мы сталкивались при локализации NCC на английский и немецкий языки и о том, как мы решали эти проблемы. Конечно, на сегодняшний день мы решили далеко не все свои задачи и, скорее всего, этот процесс вообще бесконечен. В статье рассматривается видение всего процесса в целом и те принципы, которым мы стараемся придерживаться или которые начинаем пробовать применять. Материал будет полезен тем, кто только начинает проектировать ПО, планирует его локализацию или уже сталкивается с проблемами, но пока не знает как их решить.
Как мы искали замену MS Word, а вместо этого внедрили новый процесс управления документами
2019-08-16 в 7:19, admin, рубрики: atlassian, confluence, база знаний, документация, приборостроение, техническая документация, управление знаниями, Управление продуктом, управление проектами, управление разработкойMS Word регулярно подкидывает нам «сюрпризы»: «съехавшие» скриншоты, «плывущие» таблицы, пустые страницы при печати. Эта статья о том, как мы искали замену MS Word, (спойлер — не нашли), а нашли возможность глобально улучшить наш процесс работы с документацией.
Вредные советы: как правильно писать техническую документацию?
2019-02-23 в 11:43, admin, рубрики: guidelines for users, technical guidelines, Блог компании Parallels, техническая документация, технический писатель, управление проектами, управление разработкойСоветы по грамотному написанию технической документации для пользователей.
Часть 1
В одной из предыдущих статей мы в общих чертах рассказывали, как именно происходит процесс документирования и локализации наших продуктов.
На этот раз под катом – руководство нашего технического писателя Андрея Старовойтова, которое поможет сделать вашу документацию для пользователей проще и понятнее (описанные приемы применяют при документировании своих продуктов Apple, Microsoft и другие компании).
Читать полностью »
Ландшафт сервисов облачного машинного перевода. Лекция в Яндексе
2018-11-18 в 10:09, admin, рубрики: Блог компании Яндекс, локализация, Локализация продуктов, машинное обучение, машинный перевод, сравнение сервисов, техническая документацияЭто последний доклад с шестого Гипербатона, который мы опубликуем на Хабре. Григорий Сапунов из Intento поделился подходом к оценке качества сервисов облачного машинного перевода, рассказал о результатах оценки и главных отличиях между доступными сервисами.
— Меня зовут Григорий Сапунов, я расскажу про ландшафт сервисов облачного машинного перевода. Мы измеряем этот ландшафт уже больше года, он очень динамичен и интересен.
Читать полностью »
Новый взгляд на документирование API и SDK в Яндексе. Лекция на Гипербатоне
2018-10-29 в 7:00, admin, рубрики: api, SDK, Блог компании Яндекс, документирование кода, инструкции, Локализация продуктов, тексты, техническая документация, Яндекс APIМеня зовут Андрей Поляков, я руководитель группы документирования API и SDK в Яндексе. Сегодня я хотел бы поделиться с вами докладом, который я и моя коллега, старший разработчик документации Юлия Пивоварова, прочитали несколько недель назад на шестом Гипербатоне.
Светлана Каюшина, руководитель отдела документирования и локализации:
— Объемы программного кода в мире в последние годы сильно выросли, продолжают расти, и это влияет на работу технических писателей, которым приходит все больше задач на разработку программной документации и документирования кода. Мы не могли обойти стороной эту тему, посвятили ей целую секцию. Это три взаимосвязанных доклада, посвященных унификации разработки программной документации. Я приглашаю наших специалистов по документированию программных интерфейсов и библиотек Андрея Полякова и Юлию Пивоварову. Передаю им слово.Читать полностью »