Публикации
Адвокат пользователя: пересечение воображаемого разлома
23.09.2016
Фил Девис (Phil Davis) занимается управлением разработки документации в Integral Development Corp. в Калифорнии. За 20 лет работы он много раз сталкивался с мифами о работе технических писателей и в сегодняшней статье развенчивает один из них. Итак, могут ли программисты писать, а писатели программировать?
В последнее время я часто слышу много сплетен о мифе: писатели не могут программировать, а программисты не могут писать.
Большинство этих сплетен идут от несостоявшихся писателей и писателей-философов, которые заявляют, что этот миф — полнейшая ерунда.
Согласен, но также я начал задавать себе вопросы: Почему этот миф существует? Почему мы обсуждаем его сейчас? Что он значит? Читать дальше…
Представляем Doc-To-Help 4
15.09.201613 сентября 2016 года компания MadCap Software выпустила новую версию продукта для профессионального документирования на базе Microsoft Word — MadCap Doc-To-Help 4. Компания «ПроТекст» является прямым партнёром компании MadCap Software. Вы можете приобрести Doc-To-Help 4 в нашем магазине уже сейчас.
Наиболее эффективное решение для авторинга и публикации руководств и инструкций, онлан-помощи, электронных книг и другой документации с помощью Microsoft® Word.
После недели работы с Doc-To-Help я увлеклась. Не могу представить разработку технической документации на базе Word без Doc-To-Help. По моему мнению, Doc-To-Help и Word были созданы друг для друга.
Пегги Фентон, главный технический писатель
Итак, вам нужно документировать API…
09.09.2016
Что такое API, для чего используется, зачем и как начать его документировать, какие инструменты использовать, как взаимодействовать с коллегами, какие существуют основные принципы. Очень полезная статья для технических писателей, которые хотят роста. Начинайте документировать API, разберитесь в этом – и карьерный рост вам обеспечен! Получить первое представление вам поможет эта статья. Автор – Лоис Паттерсон (Lois Patterson), технический писатель API из компании Global Relay (Канада).
Тяжело отследить, сколько раз API (Application Programming Interfaces, интерфейсы программирования приложений) сопровождают нашу жизнь каждый день или даже каждый час. Когда проходит ваша транзакция в PayPal или когда вас подбирает водитель Uber, само по себе API невидимо, и это более чем типично для пользовательского программного обеспечения. API используется даже тогда, когда вы встраиваете YouTube-видео в запись WordPress. При наличии сотен тысяч общедоступных API, доступных широчайшему кругу пользователей, компании находятся под большим давлением, чтобы их API были легки и удобны для использования. Не будет сюрпризом то, что рост количества вакансий, связанных с документированием API, огромен — он показывает разогретый рынок для технических писателей, которые специализируются на документировании API. Читать дальше…
Перевод и локализация. В чем разница?
02.09.2016
В заголовок статьи вынесен, казалось бы, простой вопрос. Статью из журнала мы переводим, приложение – локализируем, ничего сложного. На самом деле всё не так. Как выясняется, очень многие, в том числе заказчики переводческих услуг, разницы между двумя терминами не видят, а следовательно, не хотят выделять физические и финансовые ресурсы на априори более сложный и долгий процесс локализации. Фразу «зачем вам время на исследования, сел да перевёл быстренько» можно услышать до неприятного часто. Поэтому мы хотим немного рассказать о разнице между этими двумя понятиями (а вы, возможно, покажете эту статью своему заказчику, чем его и убедите).
Чтобы конкурировать в условиях современной глобальной экономики, организациям нужно адаптировать веб-сайт и цифровой медиа-контент к международной аудитории. И тем не менее, многие компании, большие и маленькие, не понимают важных различий между переводом и локализацией. В этой статье д-р Нитиш Сингх рассказывает о переводе по сравнению с локализацией и объясняет, почему два дополняющих друг друга процесса имеют большое значение, но по-разному. Читать дальше…
Проблема документирования: является ли структурированный контент залогом значительных улучшений?
24.08.2016
10 обстоятельств для внедрения DITA на предприятии
Даже сравнительно небольшая компания или организация генерирует множество документов. Когда вы сталкиваетесь с более крупным контекстом, то имеете дело с тысячами или даже миллионами страниц документации, отчётов, маркетинговых материалов, регулярными документами о соответствии законодательству, презентациями… ошеломляющий объем контента. Этот контент со временем станет огромным капиталом и будет рассматриваться как значимое, ценное имущество компании. Почему? Потому что этот контент — ваша первая линия взаимодействия с клиентами, он позволяет таким группам, как HR и поддержка пользователей работать гладко и эффективно, и он представляет собой одновременно интеллектуальную собственность и опыт вашей организации или компании. Но также очень часто он расположен в таких неструктурированных средах для авторинга как файлы Microsoft Word, что делает практически невозможным централизованно управлять этими фондами.
К счастью, есть централизованное решение, основанное на открытых стандартах, масштабируемое и очень экономичное. Построенное на стандарте Darwin Information Typing Architecture (DITA), разработанном IBM для решения их собственных проблем с документацией, это решение представляет собой залог значительных улучшений относительно устаревших моделей создания и управления находящегося в эксплуатации контента, которые сегодня всё ещё широко используются. Когда DITA интегрируется с окружением для авторинга/управления (компонентная система управления контентом, или CCMS), этот стандарт предлагает решение с заделом на будущее решение буквально всех ваших проблем, связанных с управлением документацией. Десять обстоятельств, указанные ниже, показывают масштабируемость, гибкость и значительную экономию средств при переходе на DITA CCMS. Читать дальше…
Стратегические заметки по переносу контента в DITA CCMS
19.08.2016
Мы возвращаемся к одной из любимых тем – структурированный контент и DITA. Мы уже рассказывали о плюсах структурного подхода к контенту, а сегодня хотим рассмотреть, какие сложности могут вас ожидать при переходе к подобной стратегии.
После того, как вы решите, что разумно было бы управлять контентом в масштабах предприятия, вы столкнётесь с целым рядом острых вопросов, касательно стратегии перехода к структурированному контенту, к примеру, к DITA CCMS. Один из самых важных вопросов – что делать с уже существующим контентом. К сожалению, волшебной кнопки «Перенести всё» не существует. Если учесть разнообразие форматов контента (Word, FrameMaker, PPT, PDF, онлайн-приложения, базы знаний и т.д.) и количество разрозненных мест его хранения (локальные компьютеры, сетевые диски, общие хранилища), перенос контента покажется очень и очень страшным зверем. Но есть и хорошие новости – возможности переработки существующего контента и рабочих процессов всё же существуют. Читать дальше…
Акция: 10% скидка на курс
15.08.2016
А у вас просыпается к 1 сентября желание учиться? 
Воспользуйтесь скидкой -10% на курс «Разработка технических текстов и документации» и получите новую профессию!
с 15 августа по 15 сентября мы предоставляем скидку 10% на курс «Разработка технических текстов и документации». Для получения скидки необходимо оплатить обучение в этот период. Записывайтесь через форму на странице курса! Есть вопросы? Звоните нам по тел. +7-925-328-76-00
Как использовать Google Analytics для наполнения сайта
12.08.2016
На прошлой неделе мы писали о том, зачем вообще техническому писателю разбираться в Google Analytics. Сегодня мы расскажем о плюсах использования этого инструмента на частном примере – наполнение и продвижение сайта.
Чтобы стратегия контент-маркетинга была успешной, её нужно подкреплять данными. Так, если стратегия не подтверждена чем-то реальным, она вряд ли увеличит продажи, приведёт новую аудиторию или поможет в чём-то важном.
Как писатель и редактор я использую Google Analytics и получаю точные цифры, как и на что реагирует аудитория, чтобы усовершенствовать свои методы. Читать дальше…
Первый Доквариум. Запись вебинара
10.08.2016
Ура, начало положено! 28 июля прошёл наш первый Доквариум. А то, что он будет первым, а не единственным – это уже окончательное решение, так как мы получили много положительных отзывов. Если вы ещё не слышали об этом мероприятии, посмотрите на этой странице нашего сайта.
Как прошёл вебинар:
- Мы выслушали рассказ с презентацией Анастасии Тян из компании АСКОН об её опыте использования MadCap Flare. Анастасии задали множество вопросов, на которые она ответила, продемонстрировав глубокое знание возможностей инструмента.
- Александр Денисов, руководитель группы разработки документации компании NAUMEN, рассказал о том, как он и его коллеги используют MadCap Flare. Обсудили проблему задания ролей для документации, которая возникла в его работе.
- Валерий Ледовской, технический директор компании «ПроТекст», показал, какими инструментами мы пользуемся при выполнении проектов по локализации программного обеспечения и переводах документации на аутсорсе.
- Илья Дмитриенко, технический писатель из «Лаборатории Касперского», рассказал, как и для чего в компании используют инструмент Autor-it.
- Обсудили планы на будущее.
Зачем техническому писателю разбираться в Google Analytics
05.08.2016
Маркетинг сегодня вышел на первый план. Нужно не только создать продукт, но и суметь его продать. То же самое относится и к контенту. Каким бы великолепным ни был документ, он бессмыслен, если аудитория его не увидит. Помочь нам понять, что хочет аудитория и в каком виде она хочет это получить, призваны различные инструменты аналитики. Сегодня мы поговорим о самом популярном из них – Google Analytics, и узнаем, зачем необходимо уметь разбираться в нём. А в следующем посте нашего блога вы найдёте информацию о том, как писателю использовать Google Analytics для лучшей веб-документации.
План контент-маркетинга, который призван обеспечивать рентабельность инвестиций, частично состоит из творческого вдохновения, а частично из фактов и здравого смысла. Было бы неразумно выбрать направление с чёткой ориентацией на цели без глубокого понимания критериев анализа. Это значит, что вашим стратегам абсолютно необходимо разбираться в Google Analytics. Именно квалифицированных консультантов по аналитике большинство компаний ищут в контент-маркетинговых агентствах. Мы считаем, что сильная команда по контент-маркетингу предоставляет данные аналитики каждому из заинтересованных участников проекта. Читать дальше…