Публикации
Когда вашей документации требуются скриншоты?
30.09.2015
Скриншотам – быть или не быть? Существуют ситуации, когда скриншоты необходимы, но в основном они только мешают. Какой потенциальный вред от скриншотов бывает и как определиться с их количеством – читайте в статье.
Один из частых вопросов при разработке документации: «Сколько скриншотов она должна включать?» Ответы разнятся от «Ни одного!» до «Все окна!». Картинка может заменить тысячи слов, но скриншоты часто используются в качестве «костыля» для некачественной документации или некачественного дизайна. Лучший ответ — использовать их там, где необходимо, и не использовать в других случаях. Но как узнать, когда они необходимы? Читать дальше…
Структурированное писательство: работа в домене носителя
23.09.2015Статья входит в цикл «Понимание и применение структурированного писательства».
Марк Бейкер продолжает свою постоянную серию по структурированному писательству с глубоким погружением в тему о том, какие преимущества в структуре даёт писательство в домене носителя для представления абстрактных концептов в конкретных формах. Узнайте больше в предыдущих частях, в которых производится попытка определить структурированное писательство, а также описать три домена структуры контента.
Домен носителя — это домен структурированного писательства, в котором структуры имеют отношение к носителю, в котором отображается контент. Такой контент часто считается «неструктурированным», но на самом деле это означает «неструктурированный так, как это в настоящий момент нужно мне». Фактически любой контент имеет структуру, и мы действительно можем найти шаблоны и техники для всех форм структурированного писательства в домене носителя. Это делает этот домен хорошим предметом для изучения основ структурированного писательства. Читать дальше…
Новинка в нашем магазине: Doc-To-Help
18.09.2015
Мы рады сообщить о том, что теперь в нашем интернет-магазине можно приобрести продукт Doc-To-Help. Это продукт с богатой историей. Он был представлен в 1991 году как первый профессиональный инструмент для конвертации документов Microsoft Word в онлайн-руководства. После этого постепенно Doc-To-Help начал превращаться в инструмент для реализации преимуществ технологии единого источника при использовании Microsoft Word как привычной среды для создания контента. С 1 января 2015 года данный продукт принадлежит компании MadCap Software и в настоящее время активно интегрируется в другие продукты линейки.
Doc-To-Help устанавливается как отдельная программа, в которой создаются собственные проекты, при этом создание и редактура документации может производиться в Microsoft Word, в котором Doc-To-Help работает в качестве надстройки. Если вы привыкли создавать документы в Word, хотите продолжать работать в привычной среде и при этом пользоваться преимуществами единого источника, то Doc-To-Help – просто идеальное решение для вас! Читать дальше…
Встречайте Doc-To-Help
Используйте 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% на курс!
Подробнее о мероприятии можно прочитать здесь.