Git, Github, управление версиями и вы

19.08.2015

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

Подумайте о тысячах и тысячах полностью бесплатных и открыто доступных пакетов исходного кода для программного обеспечения профессионального уровня, которые вы можете установить и «ковыряться» с ними на собственном компьютере для развлечения и заработка (помните, условия лицензий отличаются, так что всегда проверяйте их перед установкой). Сложно подсчитать, но на самом деле средний пользователь компьютера имеет прямой доступ к программам стоимостью многие миллионы долларов, если их оценивать старым общепринятым способом. Это верно в любом значении данной фразы. Читать дальше…

3 основные ошибки управления контентом в компаниях

21.05.2015

Бывает, что в компании есть огромное количество контента. Например, вы производите множество программных продуктов, каждый из которых обновляется, имеет разные версии (положим, для стационарных ПК и мобильных устройств), к каждому продукту есть руководство пользователя, к некоторым – руководство администратора, руководство системного программиста, а также море маркетинговых материалов и т.д. и т.п. Причём каждый из документов в нескольких форматах – для веб-справки, для публикации на сайте, для печати, для просмотра на экране… Как справиться со всей этой горой контента и выстроить работу максимально эффективно, советует Джекки Сэмюэлс.

Люди тратят сумасшедшее количество времени на попытки создать, найти, распространить, обновить и ещё что-либо сделать со своим контентом. Ковыряются в электронной почте, ищут в папках, лазят по ресурсам локальной сети… Быстро ли вы находите информацию? Ту ли информацию ищете, которая вам нужна? Уверены ли, что она актуальна и не содержит ошибок? Если она больше не соответствует действительности, вы узнаете об этом? Читать дальше…

Как организовать цикл обратной связи по переводам, который действительно работает

30.01.2015

Самое главное в любом переводе – чтобы он был качественным и максимально близко соответствовал оригиналу. При этом сроки, как правило, очень ограничены. Сегодняшняя статья Ли Денсмер (Lee Densmer) – о цикле обратной связи и об инструменте, который поможет добиться того, чтобы переводчики перестали делать одни и те же ошибки, совершенствовали свои навыки на основе полученной обратной связи. Также этот инструмент поможет вам выявить слабые звенья в вашей переводческой команде.

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

Бассейн для всех: Не только технические писатели могут использовать DITA

22.01.2015

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

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

Читать дальше…

Как продвигать отдел документирования (Часть 2)

19.12.2014

Как часто мы видим ситуации, когда отличный специалист с инженерным образованием и выдающимся даром слова не может найти заказ? К сожалению, очень часто. И тут нужно вспомнить о слове «маркетинг». Себя и свои услуги нужно продвигать и продавать, а если вы работаете в команде, то и продвигать нужно всю команду. А теперь представьте, что этим будет заниматься каждый сотрудник по мере сил и умений. Открываются довольно приятные перспективы для всего отдела, не правда ли?

Продвигаем с помощью положительных ответов

Конечно, вы не можете ответить «да» на всё. Если задача требует большое количество неоплачиваемой работы или выходит за рамки контракта, то могут появиться перерасходы, которых следует избегать. Но сегодня очень много небольших запросов от клиентов встречают отговорками или того хуже; если запрос можно легко выполнить, этот акт доброй воли может оказаться бесценным. Например, один из наших сотрудников получил эту записку в ответ на относительно небольшую услугу: «Отдел технических коммуникаций – единственный в компании, на помощь (а не разговоры о ней) которого мы всегда можем рассчитывать». Очевидно, что этот внутренний заказчик обратится к нам ещё. Читать дальше…

Как продвигать отдел документирования (часть 1)

17.12.2014

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

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

Когда вы только вступаете в ряды технических писателей, продвижение отдела вряд ли занимает ваши мысли. У вас и так есть работа, а продвижение – дело кого-то другого. Но теперь, занимая позицию, на которой приходится читать рассылки типа TechCom Manager, вы, возможно, задумаетесь о продвижении. Возможно, для выживания отдела документирования вам даже придётся стать его маркетологом. Не факт, что внутренние и внешние клиенты будут запрашивать ваши услуги, даже в пределах одной корпорации. В компании, где я работаю управляющим отдела технических коммуникаций, у нас существует относительно свободная рыночная экономика, где клиенты могут пользоваться нашими услугами по написанию руководств, а могут и не пользоваться. Следовательно, продвижение нашего отдела на рынке находится в рамках моих обязанностей. Статья описывает, как мы продвигаем наши услуги для внешних и внутренних клиентов. Читать дальше…

Встречайте MadCap Lingo 9

12.12.2014

Спешим представить обновлённый продукт от наших партнёров – компании MadCap Software. Lingo 9 не имеет принципиальных отличий от предыдущей версии, но становится ещё более удобным, расширяет список поддерживаемых файлов и предлагает новые возможности для рецензирования. Напомним, что приобрести новый продукт вы можете в нашем магазине. Рассмотрим основные новшества, появившиеся в новой версии этого продукта.

Просматривайте переводы в режиме реального времени с динамическим просмотром редактора переводов

Отображение предварительного просмотра переведённого файла рядом с исходным контентом в редакторе перевода. Читать дальше…

Тематическое исследование Huawei: Решение коммуникационных проблем по всему миру (часть 2)

21.11.2014

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

Продолжаем перечислять обязанности службы технической коммуникации:

2. Обеспечивать поддержку создания конкурсных и маркетинговых документов.

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

Тематическое исследование Huawei: Решение коммуникационных проблем по всему миру (часть 1)

19.11.2014

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

Эмма Лилин имеет степень бакалавра в области электротехники и степень бакалавра экономики Шанхайского университета. Она работает в технической коммуникации более двенадцати лет. До этого она была техническим специалистом по обслуживанию в сфере продуктов питания. Эмма в настоящее время работает в отделе информационного проектирования в компании Huawei Technologies.

Я — одна из более чем тысячи технических писателей Huawei, лидирующего поставщика информационных технологий более чем в 170 странах и регионах. При таком масштабе, когда речь заходит о коммуникации, Huawei приходится решать глобальные проблемы.

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

Собираем эффективную команду для электронного обучения (часть 3)

14.11.2014

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

Собеседование с кандидатами в проектную команду

Независимо от квалификации людей, старайтесь не выбирать в члены команды кандидатов, которые не разделяют стратегического видения проекта. Стратегическое видение – это «почему» и «что», а не «как». Почему ваша команда согласилась взять проект? Что является главной задачей (задачами) помимо выходных результатов? Построить деловые отношения между вашей компанией и клиентом? Развивать младших членов команды? Поддержка стратегического видения требует обязательств со стороны членов команды работать для команды, а не для своих личных целей. Читать дальше…