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

Публикации

Работа на несколько эджайл-команд (часть 2)

16.04.2014

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


Когда вы работаете на несколько команд, вы можете тратить 4-5 часов в неделю (или больше) на совещания для каждого назначенного проекта. Переговорите с руководителем или менеджером, чтобы распределить нагрузку таким образом, что вы можете делегировать обязательства посещений совещаний другим. Вот несколько предложений:

  • Участвуйте только в совещаниях, которые относятся к самому приоритетному проекту на данный момент.
  • Попросите человека, проводящего совещания, отправлять отчеты по электронной почте, чтобы помочь тем, кто не может присутствовать на каждом заседании для каждого проекта.
  • Попросите руководителя или менеджера посещать некоторые важные встречи, когда вы не можете.
  • Перестаньте посещать ненужные встречи. Даже если исторически сложилось, что вы присутствуете на определенного рода встречах, если вы не получаете от них достаточно, чтобы расширить свои знания о продукте или внести вклад в контент, над которым вы работаете, возможно, ваш лучше потратить это время на что-то другое.
  • Всё больше и больше распределенных команд работают в эджайл-среде. Многие команды используют онлайн-инструменты для совместной работы для проведения совещаний и создания постоянных отчётов об обсуждениях. Рассмотрите возможность использования онлайн-инструментов для совместной работы для одной или нескольких ваших команд, что позволит вам, если вы пропустите встречу, проверить запись позже.

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



Работа на несколько эджайл-команд (часть 1)

14.04.2014

ЭджайлМы продолжаем публикации на тему эджайл-разработки. Сегодня Алисса Фокс поделится опытом, как организовать одновременную работу над несколькими проектами без ущерба для качества.


Обзор

Казалось бы, клише «делать больше с меньшими затратами» в большинстве компаний сегодня является суровой реальностью. Людям надо делать больше, а времени и средств на это у них меньше. Для софтверных компаний один из способов это осуществить – частое и постоянное движение ресурсов между несколькими проектами. Когда моя команда начала использовать процессы эджайл-разработки, мы долго искали информацию о том, как использовать этот процесс при работе на несколько эджайл-команд. Мы обнаружили, что большинство писателей, занимающихся эджайл-разработкой, работали всего с одной командой разработчиков. Как у «плавающих» писателей, у нас теперь есть уникальные проблемы в эджайл-разработке.

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



Измените подход к написанию контента: альтернативы DITA (часть 2)

11.04.2014

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


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

SPFE: Разработка Марка Бейкера SPFE (Synthesis, Presentation, Formatting, and Encoding – Синтез, Презентация, Форматирование и Кодировка) является запросоориентированным структурированным авторским подходом, который многообещающе выглядит, но пока не имеет ни широкого распространения, ни поддержки. SPFE (или «spiffy», как называют его в англоговорящих странах) представляет собой архитектуру для построения структурированного авторинга и издательских систем, который использует функции базы данных XML в обход необходимости внедрения дорогого CCMS.

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



Измените подход к написанию контента: альтернативы DITA (часть 1)

09.04.2014

Мы много рассказывали о преимуществах DITA, но не хотим, чтобы наши читатели считали, что DITA – это единственное решение для технического авторинга и своего рода «панацея» от всех проблем, с ним связанных. Представляем вам обзор других, иногда не менее удобных и полезных, инструментов технического писателя.


Когда вы и ваша команда, и даже ваш босс придёте к выводу, что «должен быть лучший способ» писать технический контент, ваши поиски, скорее всего, приведут к DITA (Дарвиновская Архитектура Типизированной Информации) как альтернативе ночным кошмарам обработки, копипасты, форматирования и поддержки версий в Word, с которым вы так долго работали. Но, прежде чем запрыгнуть в автобус с конечной станцией «DITA: Земля обетованная», помните, что существуют жизнеспособные альтернативы DITA, которые могут даже лучше удовлетворять вашим потребностям.

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



Советы и хитрости: FrameMaker 12. Функции, доступные каждому

07.04.2014

FrameMakerКонсультант, тренер, разработчик курсов и преподаватель Seneca College Бернард Ашванден принимает непосредственное участие в разработке инструментов для технических коммуникаций. Он часто публикует обзоры новых приложений, уделяя внимание не только общеизвестной информации, но и «скрытым» функциям, о которых не многие догадываются. Представляем вам список таких функций продукта FrameMaker 12.


Пользователи Adobe FrameMaker могут не знать о новейших функциях FrameMaker 12, которые Adobe добавила, чтобы помочь сделать технический контент более полезным и доступным для аудитории. Чтобы помочь вам начать работу с некоторыми простыми в реализации функциями, мы рады предоставить несколько хитростей и рекомендаций, о которых могут не знать даже опытные пользователи. Конечно, у нас есть советы для пользователей с различным уровнем квалификации/опыта.

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



Создание корпоративного блога, который действительно продаёт (часть 3)

04.04.2014

БлогМы заканчиваем серию советов по ведению корпоративного блога. Надеемся, мы смогли вас убедить, что делать это не только несложно, но и крайне полезно.


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

Разместите краткую информацию о каждом блоггере – я получаю много запросов от B2B клиентов на использование авторских биографий. В 80% случаев компании хотят публиковать сообщения в блоге от лица компании, а не отдельного сотрудника. Это снижает фактор доверия и не помогает позиционировать организацию как эксперта по вопросам. Читатели хотят знать, кто написал статью, и хотят знать больше об авторе. Напишите краткую, но информативную биографию автора и включите его в нижнюю часть каждого сообщения.

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



Создание корпоративного блога, который действительно продаёт (часть 2)

02.04.2014

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


  • Пишите контент для вашей целевой группы – на протяжении многих лет наша фирма очень активно развивалась, и мы использовали блоги как способ стимулирования этого развития. Я думаю, одним из самых больших факторов такого роста была наша способность сосредоточиться на наших целевых читателях, а не на конкурентах. Задача может показаться простой, но на самом деле это не так. Многие компании (особенно в нашей отрасли) пишут тексты для других, как для самих себя, и не думают, что этим людям нужно продать что-либо или заманить в потенциальные клиенты. Возьмите этот блог в качестве примера. Я писал его для маркетолога или владельца малого бизнеса. Я сделал так, потому что это наш целевой рынок. Другие компании, занимающиеся WordPress, часто пишут о WordPress-коде, особенно о PHP и CSS. Поймёт ли это средний маркетолог или владелец малого бизнеса? Не-а. Побудит ли их этот блог стать новым клиентом? Не-а. Заинтересует ли их длинный блог об улучшении корпоративного блога? Я думаю, да, и именно поэтому я пишу о таких темах. Наша воронка продаж и поток доходов подтверждает тот факт, что эта практика выгодна. Читать дальше…



Создание корпоративного блога, который действительно продаёт (часть 1)

31.03.2014

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


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

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

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



Итоги конференции ТехДок 2014: Софт

28.03.2014

techdoc2014soft-300x49Дорогие друзья!

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

Спасибо всем участникам за уделённое время и за интересные вопросы докладчикам. В течение дня конференции максимальное количество участников было 80 человек, а в среднем число присутствующих держалось на уровне 75 человек.

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



Рецензия на книгу «Каждая страница – это первая страница». Добавьте её к арсеналу

В 2013 году Марк Бейкер выпустил интересную и, несомненно, полезную для многих книгу «Каждая страница – это первая страница». Представляем вам рецензию на данную книгу, сделанную Рейчел Хотон, техническим писателем с более чем 14-летним стажем работы.


С большими ожиданиями я взяла свой ??собственный подписанный экземпляр книги Марка Бейкера «Каждая страница – это первая страница» на мероприятии LavaCon 2013 года. Я даже взяла вторую копию для местного отделения научно-технического центра, чтобы разыграть его в качестве приза на следующем заседании. Потом меня попросили дать рецензию на эту книгу для TechWhirl.

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

Марк разделил свою книгу на три части: контент в веб-контексте, характеристики топиков «каждая страница – это первая страница» и написание топиков «каждая страница – это первая страница»

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