Встречайте MadCap Flare

30.05.2014

В наши дни постоянно наблюдается рост числа видов и подвидов устройств, с которых мы постоянно потребляем контент: обычные компьютеры с большими мониторами уже давно вытесняются удобными компактными планшетами с экранами 7-10 дюймов, смартфонами с диагональю от трёх дюймов, ваш контент могут загрузить даже с плееров и электронных книг! Чтобы контент оставался одинаково удобным для чтения и привлекал максимально широкую аудиторию, компаниям приходится следить за изменениями в мире технологий, подключая к своему производству всё новые форматы, но и не забывая о тех пользователях, которые любят просматривать информацию с больших экранов мониторов, распечатывать её или же привыкли покупать глянцевые журналы. Чтобы оставаться в тренде, но при этом тратить на создание и публикацию контента разумное количество времени, нужен хороший инструмент. Желательно один, который может справиться со всеми задачами. Мы поискали такой инструмент в России и не нашли его. Тогда мы решили поискать в других странах. Мы исследовали несколько продуктов для работы технических писателей, производимых и использующихся по всему миру, и остановили свой выбор на линейке продуктов американской компании MadCap Software. Эта компания существует на рынке уже много лет, имеет представительства по всему миру и постоянно дорабатывает и улучшает свои продукты.
С помощью продуктов MadCap можно не только создавать и публиковать контент из единого источника во все необходимые форматы сразу нажатием одной кнопки, но и совместно рецензировать и редактировать контент; локализовывать тексты на разные языки, в том числе и азиатские, локализовывать видео и изображения; создавать и редактировать видеоролики и изображения, причём делать всё это максимально автоматизировано и удобно.
Эти продукты уже известны многим в России, но пока далеко не всем. Компания ПроТекст в скором времени станет официальным представителем компании MadCap в России, мы будем поставлять продукты и впервые в нашей стране оказывать клиентам техподдержку по этим продуктам на русском языке. Если продукты MadCap вызовут значительный интерес на российском рынке, то через некоторое время мы планируем локализовать интерфейс и документацию к ним на русский язык. Сегодня мы начнём знакомить вас с линейкой продуктов MadCap, и первой программой станет Flare – флагманский продукт, с которым идеально интегрируются другие компоненты линейки программного обеспечения от MadCap. Надеемся, что вы проникнетесь продуманностью и функциональностью этого программного обеспечения, как и мы, а сотрудники нашей компании постараются сделать всё, чтобы российским пользователям программных продуктов MadCap стало комфортнее пользоваться этим полезным инструментом.

Итак, поехали! Читать дальше…

Главные вопросы технической коммуникации

28.05.2014

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

Какова ценность технической коммуникации?

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

И всё-таки очень немногие технические авторы и люди, ответственные за документацию, это делают. И если контент-стратеги измеряют, изучают и многократно улучшают контент, технические авторы слепо уверены, что производят отличный контент, который нужен пользователю.

Во времена урезанного бюджета техническим писателям жизненно необходимо продемонстрировать ценность того, что они создают. Читать дальше…

Итоги конференции Гипербатон

27.05.2014

24 мая 2014 года в Москве прошла конференция Гипербатон, проводимая компанией Яндекс. На конференцию съехались специалисты по документированию и техническому переводу из разных уголков России и ближнего зарубежья. В течение субботнего дня прозвучали 7 тематических докладов, так или иначе связанных с тематиками технического писательства, локализации программных продуктов и документации, а также технического перевода. В работе конференции, кроме докладчиков от компании Яндекс приняли участие представители компаний Лаборатория Касперского, ABBYY и ПроТекст.

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

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

Арина Кирпичева, разработчик технической документации компании Яндекс, рассказала о первых 5 месяцах своей работы в компании. Её работа связана с документированием API сервиса Яндекс.Карты. Арина рассказала о том, с какими проблемами ей пришлось столкнуться в начале работы и как они были преодолены. Она внушила слушателям мысль о том, что какая бы сложная задача перед писателем не стояла, её всегда можно решить, разбив сложную задачу на этапы и не пренебрегая горизонтальными связями в компании, в которой работаешь. Читать дальше…

Как стать эффективным техническим писателем

26.05.2014

Вопрос, которым задаются все начинающие писатели, – как работать наиболее эффективно. Дэннис Ридли предлагает несколько советов, возможно, они покажутся банальными и очевидными, но, как показывает практика, оказываются основополагающими в успешной карьере. Итак, памятка для начинающих (и не очень) писателей.

Практика технического писательства сильно отличается от художественного с точки зрения цели и стиля. Последним обычно занимаются поэты и прозаики, они любят играть со словами и ломать нормы традиционного письма для внесения стиля и красоты в свои произведения. Использование расплывчатых образов допускается в художественном писательстве; однако, для технических писателей недопустимо выражать в работе чересчур много творчества. Техническое писательство характеризуется как формальный путь передачи ясного и чёткого послания читателям. Оно строго утилитарно, с единственной целью – сообщить, а не позабавить или развлечь; обычный стиль для новостей, редакционных колонок и деловых статей.

Ниже приведены практические советы, которые помогут вам улучшить ваш стиль. Читать дальше…

Следуйте инструкции и всё получится

23.05.2014

И снова коснёмся юмора технических писателей. Потратив несколько часов на поиски, мы обнаружили, что подобных материалов не так уж и много. Мы отыскали пару забавных стихотворений, несколько очень профессиональных, непонятных другим, шуток и, конечно, популярную серию комиксов. Тогда мы задались другой целью – отыскать старейший пример юмора техписов. Спешим поделиться своей находкой. Источники утверждают, что инструкция вполне реальна и некоторое время поставлялась в комплекте с жёстким диском и другой, на этот раз, настоящей инструкцией.

Поздравляем! Вы приобрели очень хорошее устройство, которое подарит вам тысячи лет безотказной работы, хотя его, несомненно, уничтожит какое-нибудь действие потребителя-балбеса.

Именно поэтому мы просим вас:

ПРОЧТИТЕ ДАННОЕ РУКОВОДСТВО ПОЛЬЗОВАТЕЛЯ, ПРЕЖДЕ ЧЕМ РАСПАКОВАТЬ УСТРОЙСТВО. ВЫ УЖЕ РАСПАКОВАЛИ ЕГО, НЕ ТАК ЛИ? ВЫ РАСПАКОВАЛИ ЕГО И ПОДКЛЮЧИЛИ ЕГО К КОМПЬЮТЕРУ, И ПОИГРАЛИ С КНОПОЧКАМИ, А ТЕПЕРЬ ВАШ РЕБЁНОК, ТОТ ЖЕ РЕБЕНОК, ЧТО СУНУЛ СОСИСКУ В ВИДЕОМАГНИТОФОН И ПОСТАВИЛ ЕГО НА «БЫСТРУЮ ПЕРЕМОТКУ», ЭТОТ РЕБЕНОК ТОЖЕ ИГРАЕТ С КНОПОЧКАМИ, НЕ ТАК ЛИ? ВЫ ЗНАЕТЕ, ЧТО МЫ ПРОСТО МОГЛИ УНИЧТОЖИТЬ ЭТО УСТРОЙСТВО ЕЩЁ НА ЗАВОДЕ, ДО ТОГО, КАК ОТПРАВИТЬ ЕГО ВАМ? Читать дальше…

Эджайл и технические коммуникации: работа с удалёнными командами (часть 2)

21.05.2014

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

Знакомимся с членами команды

Некоторые знания о культуре удалённой команды помогут вам предугадать, как они будут взаимодействовать с другими (как с руководителями, так и коллегами) и как их личная жизнь будет пересекаться с работой. Некоторые культуры более иерархичны, некоторые менее. Понимание взаимоотношений различных уровней – это ключ к возможности сотрудничать с ними на их условиях. Это также поможет вам увидеть картину их правил, что необходимо, если вы хотите понять, почему возникло сопротивление к новым процессам и процедурам. И это даст вам возможность работать с ними, чтобы выявить сильные стороны обеих команд.

Возможно, эффективным методом для поддержания гармонии с другими членами команды будут частые встречи один на один или небольшие групповые совещания. Регулярные встречи с членами вашей команды внутри группы – гарант того, что никто не будет чувствовать себя брошенным; они также помогут установить связи, которые помогут вам в трудную минуту. Читать дальше…

Эджайл и технические коммуникации: работа с удалёнными командами (часть 1)

19.05.2014

Алисса Фокс продолжает серию статей, посвящённых эджайлу. Сегодня мы рассмотрим проблемы организации удалённой работы в команде и пути их решения.

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

Трудности работы с удалёнными командами

Часто в удалённой команде встречается ситуация «мы против них», особенно когда две команды собираются вместе в результате слияния. У вас вдруг оказываются большие команды по крайней мере в двух местах, и несложно забыть, что команда где-то в другом месте является частью вашей глобальной группы. Кроме того, если у команд в разных местах разные фоновые знания, различные рабочие процессы и разные культуры, трудность налаживания процесса совместной работы растет в геометрической прогрессии. Читать дальше…

Как задокументировать звук?

16.05.2014

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

Немножко вас заинтригую – вы когда-нибудь пробовали письменно задокументировать звук? Кажется невозможным, не правда ли?

Судя по всему, технические писатели компании Electrolux нашли весьма творческий способ это сделать. На картинке описаны звуки (шумы) издаваемые холодильником при нормальной работе: Читать дальше…

Кто переходит на DITA, а кому не надо и пытаться?

14.05.2014

Ещё раз поговорим о DITA. Формат набирает всё большую популярность и, думаем, некоторые из вас уже задумались о переходе на DITA. Давайте попробуем разобраться, стоит ли это делать именно в вашем случае.

«Обещания» системы DITA сделать контент более структурированным и простым для публикации обращены к огромному количеству компаний, которые работают с огромным количеством технического контента. На данный момент на DITA переходят очень многие предприятия, где работают от одного техписа до компаний более чем 500 штатными писателями. Так подойдёт ли DITA вашей организации, и как понять, что она вам не подходит?

Кто переходит на DITA?

Решение переходить на DITA должно приниматься, только если DITA действительно может помочь с проблемами компании, связанными с контентом. Есть неплохая идея взглянуть на действующие в компании бизнес-факторы, чтобы лучше понять, подойдёт ли вам DITA. Рассмотрим, как следующие факторы в настоящее время проявляются в вашей организации. Читать дальше…

Конференция для технических писателей Гипербатон от Яндекса

12.05.2014

Компания ПроТекст с осени 2013 года проводит тематические онлайн-конференции для технических писателей и переводчиков. Последняя конференция ТехДок 2014: Софт была посвящена программному обеспечению для организации процесса документирования на предприятиях. В ней приняли участие как зарубежные разработчики специализированного софта, так и известные российские компании.

На конференции ТехДок 2014: Софт выступила с докладом руководитель отдела документирования компании Яндекс Светлана Каюшина. Доклад вызвал у слушателей живой интерес и множество вопросов к докладчику. Также компания Яндекс выступила спонсором конкурса Конёк документатора, проводившегося перед конференцией.

24 мая 2014 года, в свою очередь, компания Яндекс проводит очную конференцию для технических писателей под названием Гипербатон в своём московском офисе. В работе конференции примут участие представители таких компаний как Microsoft, Лаборатория Касперского и ABBYY.

Компанию ПроТекст на конференции Гипербатон будет представлять технический директор Валерий Ледовской. Он примет участие в работе круглого стола в качестве эксперта по теме «Разработка документации на аутсорсе».

В работе конференции можно принять как очное участие, так и наблюдать за трансляцией через Интернет. Регистрация на мероприятие обязательна, участие бесплатное.

Компания ПроТекст приглашает всех желающих присоединиться к работе конференции Гипербатон. Увидимся в Москве 24 мая!