Всё для технического документирования
+7 (495) 001-40-42
Разработка технической документации
Курсы для технических писателей
Консультации, подбор персонала

Публикации

Управление временем и успех для технических писателей (Часть 3)

05.12.2014

5.12.14Управление временем или, как любят называть его авторы многочисленных тренингов, тайм-менеджмент – сложная, а для многих и вовсе нереальная вещь. Но мы уверены – управлять своим временем реально, и для этого даже не нужно отдавать деньги за модный тренинг. Для начала изучите статью Манфреда Зиммерманна.


Используем контрольные списки

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

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

Создаём набор руководящих принципов

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



Управление временем и успех для технических писателей (Часть 2)

03.12.2014

3.12.14Признайте, все мы хоть раз с плохо скрываемой завистью смотрели на коллегу, который успел за день выполнить все задания (наверняка их было меньше, чем у вас), помочь коллегам (подхалим) и выпить пару чашек кофе в курилке (лентяйничает в рабочее время). Хотите тоже уметь уходить с рабочего места в 18.00 под грустные взгляды придавленных дедлайнами коллег? Наша публикация как раз об этом.


Базовый принцип 3: Известные прерыватели и воры времени

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

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



Управление временем и успех для технических писателей (Часть 1)

01.12.2014

1.12.14Как часто у вас бывают дни, когда кажется, что все сговорились мешать вам работать? Почтовый сервер завис, телефон покраснел от звонков, а коллеги громко обсуждают новогодний корпоратив и требуют вашего мнения. О том, как не отвлекаться на суету, расскажет нам Манфред Зиммерманн, глава отдела технической документации крупной немецкой компании.


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

Как так получается, что некоторые люди утверждают, что им принадлежит «всё время в мире», в то время как другие, напротив, ворчат, что им постоянно не хватает времени? Это, вероятно, связано с тем, как люди управляют временем. При правильном использовании оно приводит к успеху и удовлетворению. Неверный подход к управлению временем ставит под угрозу успех, и поставленные цели не будут достигнуты. В таких ситуациях некоторые люди даже заболевают. Правильное управление временем может предотвратить это. Мы учимся эффективно управлять нашим временем и тем самым обеспечить успех, как в профессиональной, так и в личной жизни. Все технические писатели, которые хотят улучшить свой способ управления временем, должны начать с реализации четырех базовых принципов: Читать дальше…



Единый источник и дублированный контент (поисковая оптимизация) (Часть 2)

28.11.2014

28.11.4Продолжаем статью Тома Джонсона о том, почему единый источник – не всегда лучшее решение для публикации контента, но почему он при этом ещё долго не потеряет актуальности. Начало статьи тут.


Переход от печатных к веб-моделям

Марк Бейкер расширяет задачи оглавления в комментарии к предыдущему посту. Он призывает нас перейти от печатных к веб-моделям:

Я думаю, одержимость технических коммуникаторов единым источником и повторным использованием – признак того, что они застряли в «бумажном» мышлении. Повторное использование имеет смысл в бумажном мире, потому что человек, читающий одну книгу, должен приложить массу усилий, чтобы обратиться к другой книге – в некоторых случаях это может быть несколько дней или недель усилий и значительных расходов. Лучше тогда повторять материал в каждой книге, где он может потребоваться, чем ссылаться на другую книгу, которую читателю будет трудно искать. Читать дальше…



Единый источник и дублированный контент (поисковая оптимизация) (Часть 1)

26.11.2014

26.11.14Если вы сумели решить проблему с написанием качественного контента, перед вами тут же встаёт новая и не менее важная: контент, к которому не могут получить доступ пользователи, ­– это впустую потраченные деньги и время. Сегодня с помощью Тома Джонсона мы попробуем понять некоторые поисковые механизмы Google и обернуть их в свою пользу.


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

Под единым источником здесь я подразумеваю несколько интернет-версий контента, не обязательно версии для различных сред. Предположим, у вас есть 9 онлайн руководств для «ACME Software»: версия 1.0, версия 2.0, версия 3.0. И для каждой версии у вас есть руководство для начинающих, руководство администратора и гайд по должностным обязанностям (для руководства). Кроме того, у вас есть печатные версии каждого из 9 руководств. Это означает, что в общей сложности их у вас 18. Читать дальше…



OASIS утверждает стандарт обмена локализуемыми данными и сопутствующей информацией XLIFF 2.0

24.11.2014

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


IBM, Microsoft, Oracle, SDL, Symantec, научно-исследовательский центр локализации университета Лимерика и другие повышают совместимость между коммерческими и открытыми инструментами локализации.

Консорциум OASIS по международным открытым стандартам объявил об утверждении XML стандарта обмена локализируемыми данными и сопутствующей информацией XLIFF 2.0. Делая возможным взаимодействие между инструментами локализации, XLIFF освобождает издателей от сложности и дороговизны предварительной обработки локализуемого контента из собственных форматов. XLIFF 2.0 стал официальным стандартом OASIS – статус, который означает высший уровень одобрения. Читать дальше…



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

21.11.2014

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


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

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

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



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

19.11.2014

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


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

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

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



Пишем техническое задание

17.11.2014

17.11.14(1)Любая работа начинается с задания, а работа технического писателя должна начинаться с технического задания. Осталось только разобраться, что это такое и зачем оно нам нужно. Прочитайте статью Кимберли Чан, чтобы не попасть в такую же ситуацию, как разработчик из уже любимой нами серии комиксов.

Специалисты компании «ПроТекст» будут рады разработать техническое задание для Вашей компании с учётом всех нюансов. Подробности на этой странице.

 

Что такое техническое задание на разработку программного обеспечения?

Большинство разработчиков предпочитают работать с техническим заданием на разработку программного обеспечения, так как этот документ обычно содержит следующее: Читать дальше…



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

14.11.2014

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


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

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