Публикации
Dr.Explain как инструмент технического писателя
24.02.2014
Введение
В современном мире присутствует большое количество различных устройств, прикладного и специализированного программного обеспечения, использование которого без сопроводительной документации зачастую связано со значительными техническими и временными издержками. И поэтому создание качественной и понятной документации является принципиально важным фактором. Занимаются разработкой и ведением технической документации т. н. технические писатели — как правило, универсальные специалисты, способные не только разобраться в технических аспектах работы, но и грамотно их описать. В процессе работы над документацией остро возникает необходимость в удобном инструментарии, позволяющем выполнять типовые операции с минимальными затратами. Ведь техническому писателю нужно максимально быстро и просто изложить основные принципы работы устройства или программного обеспечения. Немаловажную роль в этом играют программы для создания справочных материалов в широко распространённых форматах — CHM, HTML, PDF. Одним из примеров подобных программ является продукт компании Indigo Byte Systems, LLC — Dr.Explain, о которой и пойдёт речь в данном обзоре.
Алфавит техписа
21.02.2014
Считаете, что технические писатели – это такие специальные скучные люди, с которыми можно поговорить только о пользовательских интерфейcах и сложностях форматирования в PDF? Не угадали. Техпис – очень творческая профессия, а Иешуа Пол даже сочинил стихотворение о сложных рабочих буднях технического писателя. Мы намеренно не стали его переводить, так как поэзией надо наслаждаться в оригинале. Ну а если вам непонятны некоторые слова, значит настало время расширять словарный запас. Подсказка: эти термины встречались в наших предыдущих публикациях.
A is for Acrobat to publish in print
B is for backup – you shouldn’t need the hint
C is for content which is produced en-masse
Стоимость разработки контента (часть 6)
19.02.2014
Итак, вы убедились в выгоде перехода на другие инструменты? И даже (мы вами гордимся) убедили в этом руководство? Думаете, самое сложное позади? А теперь попробуйте объявить о переменах сотрудникам. Только сначала прочитайте нашу статью, мы постараемся помочь.
Управляйте переменами
Дуглас Адамс сказал: «Перемены к лучшему. Ты оказываешься впереди».
Управление переменами является одной из самых сложных частей этого процесса. Экономическое обоснование ясно, сэкономленные деньги и затраты ясны. Что непонятно – это как изменить процессы, чтобы поддержать новую парадигму контент-разработки.
Другими словами: Как заставить людей изменить способ, которым они делают то, что они делают? Существует целая индустрия по изучению управления переменами. Мы можем призвать на помощь здравый смысл. Первый шаг для меня – это всегда выявление ожиданий.
Стоимость разработки контента (часть 5)
17.02.2014
Вы всё еще не уверены, стоит ли менять инструмент разработки контента? Сомневаетесь в экономической выгоде такого решения? А может быть, вы давно уже решились, но не знаете, как объяснить это начальству? Возможно, наша следующая статья поможет вам определиться и найти аргументы для убеждения даже самого жадного босса.
Инструменты не бесплатны
Переход на новые инструменты разработки контента, которые поддерживают топикоориентированный подход к авторингу, стоит денег. Даже бесплатные инструменты небесплатны. Деньги нужны для:
- Покупки инструмента (но существует и открытое программное обеспечение);
- Обучения людей;
- Изменения рабочих процессов;
- Перевода в новый инструмент и форматирование контента;
- И так далее.
Стоимость разработки контента (часть 4)
14.02.2014
Ранее мы рассматривали стоимость разработки контента. А во сколько обойдётся его локализация? Если вы считаете, что это вас не касается и переводить свой контент вы никогда не будете, прочитайте сперва данную статью.
Ранее я рассказывала о стоимости разработки контента в Word, FrameMaker и InDesign, а также топикоориентированных инструментах. Цифры показывают, что дешевле работать в топикоориентированных инструментах авторинга из-за возможности повторного использования контента. А что насчёт локализации?
Локализация
Локализация – процесс перевода контента и адаптация его к другой культуре. Он включает не только перевод с одного языка на другой, но и изменение системы мер и поиск примеров, подходящих для данной культуры.
Стоимость разработки контента (часть 3)
12.02.2014
Так как же сэкономить на разработке контента? Шерон Бёртон предлагает одно из возможных решений. Рассмотрите этот вариант, возможно, он придётся вам по вкусу.
В прошлых публикациях я рассказывала о стоимости разработки контента в Word и в таких неструктурированных инструментах, как FrameMaker или InDesign.
При разработке в Word вы теряете порядка 50% выделенных денег. В Frame или InDesign потери ниже и составляют около 20%. Word не позволяет повторно использовать контент, а сложности повторного использования в Frame или InDesign приводят к его жёсткому ограничению.
Ок, думаете вы, я все понял – нужно создавать и использовать контент более эффективно. Это дорого стоит. Нужно начинать думать о стоимости нашей стратегии создания контента.
И что же делать?
Как сказать. Это зависит от того, сколько у вас контента, сколько у вас писателей и сколько продуктов. А ещё это зависит от того, собираетесь ли вы в обозримом будущем переводить контент на другие языки.
Стоимость разработки контента (часть 2)
10.02.2014
Надеемся, мы не слишком вас напугали цифрами в предыдущей публикации? В тот раз мы рассмотрели стоимость при разработке контента в одном инструменте, сегодня обсудим другие. А если суммы всё же покажутся вам несоразмерно высокими, ждите наших следующих публикаций. У нас ещё есть, чем вас порадовать.
В предыдущей публикации я рассказывала о том, как дорого создавать контент в Word. Я говорила, что команда ваших писателей тратит около 50% своего времени и ваших денег, потому что не может использовать контент повторно. А ещё они борются с приложением Word.
Я привела простой расчёт, чтобы показать, сколько денег тратится на разработку контента и сколько теряется, если вы используете Word.
Давайте рассмотрим стоимость создания контента в FrameMaker или другом инструменте разработки более высокого уровня. Существуют инструменты лучше Word, но, возможно, и их недостаточно. Читать дальше…
Стоимость разработки контента (часть 1)
07.02.2014
Вы когда-нибудь задумывались, во сколько обходится разработка контента? Шерон Бёртон, менеджер по обучающим ресурсам в колледже Ричарда Хуиша, попыталась посчитать. Но не пугайтесь представленных сумм; как указывает сама автор, цифры даны довольно приблизительно, только для наглядности. К тому же стоимость подобной работы в Америке и странах СНГ существенно различается.
Скажем, у вас есть группа людей, и они разрабатывают контент в Word. Все они, не отрывая глаз от монитора, пишут контент для руководств пользователя, внутренних нормативных документов, обучения и так далее.
Возможно, эта группа работает в Word, потому что он поставлялся в стандартном пакете при покупке компьютера, так что он «бесплатен». Возможно, кое-что создаётся в PowerPoint, как например контент для ILT (инструкторских тренингов). Может быть, вы работаете в промышленности, которая должна соответствовать государственным и федеральным нормативам, например, в медицинской или финансовой отрасли, поэтому вы не можете просто игнорировать подобные документы.
Новая версия курса для технических писателей
06.02.2014
Уважаемые коллеги!
Два года назад мы создали курс для технических писателей «Разработка технической документации», год назад дополнили его содержание, увеличив объём информации почти в 2 раза. Курс стал называться «Разработка технических текстов и документации». Также в прошлом году мы предложили своим слушателям новую форму обучения – заочную. Создана она была также исходя из полученной обратной связи: из-за большой разницы во времени у слушателей в разных точках СНГ, а также из-за того, что одни желают слушать лекции в рабочее время, а другие, наоборот, в вечернее, крайне трудно было подобрать устраивающее всех расписание. Заочная форма оказалась отличным решением – ведь прослушивание записей «живых» лекций практически не отличается от личного присутствия на них. Все вопросы, возникающие по ходу прослушивания записей вебинаров, слушатели заочной формы могут задавать по электронной почте непосредственно преподавателям, а при желании даже можно обсудить их по Skype. Также вариант заочного обучения отлично подойдёт тем, кто хочет начать обучение сразу, не дожидаясь начала занятий очередной группы.
Что такое DITA и зачем нам это нужно?
05.02.2014
Представляем вам важную и познавательную статью Криса Бенца (Chris Benz), посвящённую DITA и её спецификациям. В ней мы объясним принципы работы стандарта DITA, дадим определение основным терминам и понятиям и попытаемся ответить на вопрос: «Зачем всё это нужно?». Обратите внимание, что статья написана в 2010 году, но сведения, изложенные в ней, актуальны и сейчас, поэтому мы при переводе проверили и актуализировали некоторую информацию и ссылки на стандарты. Также мы предложили свои варианты перевода основных терминов, относящихся к стандарту, и если курсор мыши расположить над подчёркнутыми в тексте терминами, то во всплывающей подсказке отобразится определение.
Многие из сегодняшних разработчиков методических программ сталкиваются с большой дилеммой.
У учащихся есть совсем немного времени, чтобы понять и научиться эффективно использовать сложные продукты и системы. Чтобы запустить рациональные программы обучения, разработчикам нужно обеспечить учащихся высококачественным обучающим контентом, настраиваемым под конкретные роли ученика, и с возможностью своевременной доставки его пользователю. В то же время, бюджет на развитие многих обучающих программ сокращается. Короче говоря, у учащихся мало времени и денег, чтобы узнать то, что им нужно знать, а у разработчиков мало времени и денег, чтобы предоставить учащимся то, что тем нужно.
Один из способов, с помощью которого разработчики могут разрешить эту дилемму – это более эффективное повторное использование контента. Для многих разработчиков лучшим способом для достижения этой эффективности является Спецификация обучающего контента (L&TC), релиз которой запущен в версии 1.2 Дарвиновской архитектуры типизированной информации (DITA).