Встречайте Doc-To-Help

18.09.2015

Используйте Doc-To-Help совместно с Microsoft^® Word^™ для производства онлайн-документации, веб-контента, контента для мобильных устройств, электронных книг или вывода на печать. Пишите свой контент единожды, и публикуйте в любых форматах и местах с Doc-To-Help.

Авторинг и публикация с помощью Microsoft^® Word^™

Doc-To-Help предлагает возможность быстрого авторинга и публикацию с помощью Microsoft^® Word^™ для создания онлайн-документации, руководств и инструкций, электронных книг и тому подобных документов.

• Избавьте контент из заточения в Microsoft® Word™ и преобразуйте его в любой формат вывода
• Создавайте документы в привычной среде с помощью Word^™ и используйте уже имеющийся контент
• Быстро и просто создавайте учебники, руководства пользователя, базы знаний и многое другое
• Публикуйте во множество форматов вывода, включая отзывчивый веб-формат, PDF, ePub и другие форматы
• Используйте уже имеющийся контент с помощью функций простого импорта
• Используйте профессиональные встроенные темы вывода или настройте собственную
• Поддержка множества языков, интеграция с MadCap Lingo
• Используйте условные тэги, чтобы составить карту контента для вывода в разные форматы
• Улучшите контроль над источниками и совместную работу
• Экономьте время, позволив Doc-To-Help делать работу для вас

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

Как структурировать объёмный текст

16.09.2015

Часто говорят о том, что нужно писать как можно короче, убирать лишнее, что никто не читает большие тексты и т.д. и т.п. Но как быть, если ваша история не помещается в тесные рамки минимализма? В статье несколько советов о том, как написать объёмный пост или какой-либо другой текст так, чтобы он не вызывал реакцию «слишком-многобукв-не-буду-читать». Автор текста: Скотт Несбитт (Scott Nesbitt).

Толпа адептов TLDR (too long, didn’t read; слишком длинно, не читал) сейчас удивится, но… в Интернете есть место для текстов крупных форм. И в печати тоже.

Я не буду подробно рассказывать, почему крупные формы важны — это тема другого поста в другое время. Если у вас есть интересная история, то нет причин, по которым вы не можете занять немного больше времени, немного больше места и чуть больше слов, чтобы рассказать её. Читать дальше…

Вебинар для руководителей «Техническое документирование для бизнеса: проблемы и решения»

14.09.2015

В этом году мы решили изменить формат мероприятия, и вместо традиционной конференции «ТехДок», рассчитанной на усреднённую целевую аудиторию, провести два разных вебинара. При этом мы не отказываемся от полюбившегося всем «ТехДок’а», а только переносим время его проведения на весну 2016 года. И как обычно заранее принимаем заявки на участие докладчиков: если у вас есть, что рассказать – пишите нам на info@protext.su.

Первый вебинар мы уже анонсировали – День открытых дверей, посвящённый профессии технического писателя – он будет интересен новичкам в профессии, фрилансерам, студентам и выпускникам технических специальностей и пройдёт 8 октября 2015.

А сегодня мы объявляем о втором событии – вебинаре для руководителей «Техническое документирование для бизнеса: проблемы и решения». Целевая аудитория вебинара: руководители бизнеса, технические директоры, менеджеры проектов, руководители отдела документирования. Участие также бесплатно. Читать дальше…

5 навыков, нужных техническим писателям для работы в стартапах

10.09.2015

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

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

Как создать портфолио, не противоречащее соглашению о неразглашении

04.09.2015

Данная статья впервые была опубликована ещё в 2011 году, но она остаётся актуальной по сей день. Автор – Конни Джиордано (Connie Giordano), работает в области технического документирования со времён Windows 95. В материале приведены цитаты юриста Мориса Росса (Maurice Ross). Росс – партнёр Barton, Barton & Plotkin, LLP, занимается интеллектуальной собственностью и патентными спорами в своих областях практики. Он часто публиковался в областях интеллектуальной собственности, патентного законодательства и адвокатско-клиентской привилегии [защищает конфиденциальность информации и документов, передаваемых клиентом адвокату] и является защитником использования альтернативных механизмов решения споров.

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

В MadCap Lingo 9.5 появились импорт из Microsoft® Excel®, поддержка проектов Doc-To-Help и другие новые функции

01.09.2015

Компания MadCap Sorftware продолжает активно развивать свои продукты. В частности, 27 августа 2015 г. вышла очередная промежуточная версия MadCap Lingo — 9.5, в которой, тем не менее, реализованы важные новые функции. Кроме того, после приобретения популярного инструмента Doc-To-Help, предназначенного для организации мультиканальной публикации при использовании Microsoft Word, MadCap Software начала интеграцию этого инструмента с другими компонентами своего комплекса для технического документирования. Актуальные версии продуктов компании MadCap Software традиционно можно приобрести в нашем интернет-магазине.

MadCap Lingo — первый полноценно интегрированный инструмент для автоматизированного перевода (computer-aided translation, CAT) и решение для организации управления, разработанное для использования в качестве инструмента для автономного перевода или в связке с разработкой контента для упрощения процесса перевода. Читать дальше…

Профессия «Технический писатель». Приглашаем на День открытых дверей!

Приглашаем начинающих технических писателей, студентов, фрилансеров и всех, кто хочет ознакомиться с профессией, на День открытых дверей!

Александр Михайлов, основной автор и преподаватель курса для технических писателей «Разработка технических текстов и документации», расскажет вам о профессии, а именно:

• Кто такой технический писатель и чем он занимается
• Навыки технического писателя как катализатор карьеры ИТ-специалиста
• Юридические варианты занятости технического писателя
• Территориальные варианты занятости
• Офис и удалённая работа
• Особенности работы технического писателя
• Отличие «технического» писателя от «классического»
• Области, где приходится работать с текстами
• Кто ещё работает с текстами
• Формирование портфолио специалиста-документатора

А также:

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

День открытых дверей пройдёт 8 октября с 19:00 до 21:00 по московскому времени в формате вебинара. Участие бесплатное. Всем участникам вебинара мы дарим скидку 10% на курс!

Подробнее о мероприятии можно прочитать здесь.

Как отличить технического писателя от автора маркетинговых текстов

27.08.2015

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

Технические коммуникации VS Маркетинговые коммуникации. Рисунок за авторством Antonio Prohias был впервые опубликован в январе 1961 года в журнале Mad Magazine (#60)

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

Для внешнего мира, для тех, кто «не в вашей песочнице», может быть сложно с первого взгляда отличить типичного технического писателя от типичного маркетингового писателя (то есть, автора маркетинговых текстов). А для того, кто живёт одной из этих профессий, разница очевидна. Если вам, вашим коллегам или друзьям трудно отличить их, воспользуйтесь простым списком, приведённым ниже, чтобы знать, какой бейджик бы подошёл человеку – технический писатель или маркетинговый. Это может помочь вам избежать часов, проведённых в состоянии фрустрации, и не задеть чувства обеих сторон… Читать дальше…

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

19.08.2015

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

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

Три домена в структуре контента

13.08.2015

Статья входит в цикл «Понимание и применение структурированного писательства».

Настоящая статья Марка Бейкера по структурированному писательству рассказывает, каким образом три домена контента работают на структурный контент. Ознакомьтесь с его первой статьёй, если хотите узнать больше о том, как Марк определяет структурированное писательство.

От идеи к точкам

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

В самом простом случае автор записывает свои идеи с помощью ручки и бумаги. Полное преобразование идей в точки происходит в голове автора. Контент записывается напрямую в окончательной физической форме.

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