Сегодня в различных публикациях, посвященных техническому писательству, уделяется много внимания вопросу употребления страдательного залога. В большинстве статей говорится об определенной двусмысленности страдательных форм при отсутствии упоминания исполнителя действия. В связи с этим, как правило, авторы статей рекомендуют избегать употребления страдательного […]
Присутствие искусственного интеллекта (ИИ) в различных областях нашей жизни – явление относительно недавнее. Около двадцати лет назад ИИ начал активно применяться в области перевода и локализации. Это было время резкого взлета переводческой индустрии и кардинального изменения роли и задач переводчика. […]
Если вы когда-либо пользовались сложным программным обеспечением, сайтом или приложением, то, скорее всего, вам встречались мануалы для пользователей. Но что такое мануал для пользователя, зачем он нужен и как создать свой собственный? Давайте разберемся в этом вместе. Что такое мануал […]
Google Analytics (GA) – это мощный инструмент веб-аналитики, разработанный компанией Google, который позволяет получать детальную информацию о поведении пользователей на веб-сайте. При использовании GA стоит учитывать, что изначально инструмент создавался не для нужд технических писателей. Его основной целью было обслуживание […]
Руководство администратора – это документ, в котором содержатся инструкции для администраторов по эффективному управлению и поддержке ПО. Этот документ помогает администраторам понять, как использовать и настраивать систему, а также как устранять проблемы, которые могут возникнуть в процессе работы. Представим себе […]
Технические писатели часто сталкиваются с ситуациями, требующими тесного взаимодействия с разработчиками. Давайте рассмотрим основные моменты, которые помогут наладить эффективное сотрудничество между техрайтерами и разработчиками, улучшить процесс написания документации и повысить её качество. Трудности в написании документации разработчиками и способы их […]
Возможно, ваша команда уже сталкивалась с ситуацией, когда технические писатели не успевают за разработчиками. На самом деле, это характерно для многих проектов. Причин, как правило, несколько, но одна из основных – неудобный инструментарий для создания и управления документацией. Отсюда несогласованность […]
Современное программное обеспечение нацелено на мобильность и универсальность использования. Именно поэтому многие сервисы и библиотеки становятся доступными через открытые интерфейсы, известные как API. Эти инструменты предоставляют программистам широкие возможности для работы с приложениями, которые они могут интегрировать в свои платформы […]
Для разработчиков, привыкших к практикам agile, всегда действует один из принципов этой методологии: «Работающий продукт важнее исчерпывающей документации». В переводе на русский с философского это значит: самое главное это рабочий продукт, который можно отдать заказчику и пользователям. При этом документация […]
Документерра отмечает сезон знаний новым релизом, направленным на улучшение вашего опыта работы с документацией. Встречайте расширенные функции уведомлений, оптимизацию ИИ-помощника и улучшенные возможности API-документации, которые принесут пользу как продвинутым пользователям, так и обычным читателям. Улучшенный импорт API доков Мы продолжаем […]