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

БЛОГ

Чат гендиректоров: Будущее контента с Майклом Розински

14.10.2016

Сегодня мы обсуждаем будущее контента с Майклом Розински (Michael Rosinski), генеральным директором Astoria Software, облачной компонентной системы управления контентом (CCMS). Розински, ветеран области управления контентом, разговаривает со Скоттом Абелем (Scott Abel), The Content Wrangler, об инновациях, информационных технологиях и о том, как искусственный интеллект повлияет на контент и тех, кто его производит.

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

michael-rosinskiМайкл: Отличный вопрос. Я верю, что наиболее захватывающая инновация в мире контента – когнитивные информационные технологии. Почему? Потому что традиционные информационные технологии хотя и впечатляющие, в то же время несколько идиотские. Нынешнее программное обеспечение для компьютеров может составлять таблицы и вычислять, хранить, управлять и доставлять файлы быстрее человека. И несмотря на то, что компьютеры намного лучше запоминают детали, они не могут предоставлять многие возможности относительно контента, необходимые современным компаниям. Однако вскоре это изменится. Читать дальше…


Atlassian Confluence в качестве среды для создания технической документации

07.10.2016

0Предлагаем Вашему вниманию статью слушателя нашего курса «Разработка технических текстов и документации» Георгия Полищука, посвящённую одной из наиболее популярных платформ для организации совместной работы над информацией Atlassian Confluence, которую часто используют в том числе для организации процессов документирования.

Компания «ПроТекст» проводит курс «Техническая документация в Atlassian Confluence». Мы учим работать в программе «с нуля», но даже если вы уже научились основам работы в программе и у вас есть вопросы или что-то не получается — добро пожаловать на курс! Опытный преподаватель подскажет, поможет, научит.

Содержание

ВВЕДЕНИЕ

КРАТКО О ПРИНЦИПАХ РАБОТЫ CONFLUENCE

ДОКУМЕНТИРОВАНИЕ В CONFLUENCE

Задачи

Решения

Экспорт документации в файлы MS Word

Создание единой структуры требования для ее использования в нескольких документах

Создание эксплуатационной документации для различных версий продукта

Привязка бизнес-процессов

Создание «динамических» отчетов

Импорт документов MS Word

Еще несколько полезных плагинов

ЗАКЛЮЧЕНИЕ

Введение

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


Инструменты для технических писателей: выбор лучших экспертов

29.09.2016

00Представляем результаты исследования Ферри Вермуелена (Ferry Vermeulen), который работает в компании INSTRKTIV, которая занимается разработкой, улучшением и управлением руководств пользователей. Исследование касается используемых программных средств подготовки и поддержки документации.


Более 70 экспертов по техническим коммуникациям указали свои предпочтительные инструменты для технического писательства.

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

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


Компании «Протекст» 5 лет

26.09.2016

00Друзья! Сегодня компании «Протекст» исполняется пять лет!

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

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

А если с точки зрения традиций, то пять лет — это достаточно короткий промежуток времени, чтобы установить крепкие корпоративные традиции (кроме лояльности к клиентам и высочайших стандартов в работе, конечно, но без этого никуда).

Так или иначе, сегодня мы отмечаем свой большой-средний-маленький юбилей! Мы уже сделали много, но ещё больше запланировано! Например, в ближайшее время выйдет книга «Профессия Технический писатель» (совместный проект ООО «Протекст» и издательствоа «Диалог-МИФИ») и будет представлена новая, дополненная и расширенная версия нашего курса.

Благодарим наших клиентов и учеников за сотрудничество, за ваши отзывы и ваш интерес к нашей деятельности!


Адвокат пользователя: пересечение воображаемого разлома

23.09.2016

00Фил Девис (Phil Davis) занимается управлением разработки документации в Integral Development Corp. в Калифорнии. За 20 лет работы он много раз сталкивался с мифами о работе технических писателей и в сегодняшней статье развенчивает один из них. Итак, могут ли программисты писать, а писатели программировать?


В последнее время я часто слышу много сплетен о мифе: писатели не могут программировать, а программисты не могут писать.

Большинство этих сплетен идут от несостоявшихся писателей и писателей-философов, которые заявляют, что этот миф — полнейшая ерунда.

Согласен, но также я начал задавать себе вопросы: Почему этот миф существует? Почему мы обсуждаем его сейчас? Что он значит? Читать дальше…


Представляем Doc-To-Help 4

15.09.2016

13 сентября 2016 года компания MadCap Software выпустила новую версию продукта для профессионального документирования на базе Microsoft Word — MadCap Doc-To-Help 4. Компания «ПроТекст» является прямым партнёром компании MadCap Software. Вы можете приобрести Doc-To-Help 4 в нашем магазине уже сейчас.


Наиболее эффективное решение для авторинга и публикации руководств и инструкций, онлан-помощи, электронных книг и другой документации с помощью Microsoft® Word.

02После недели работы с Doc-To-Help я увлеклась. Не могу представить разработку технической документации на базе Word без Doc-To-Help. По моему мнению, Doc-To-Help и Word были созданы друг для друга.

Пегги Фентон, главный технический писатель

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


Итак, вам нужно документировать API…

09.09.2016

01Что такое API, для чего используется, зачем и как начать его документировать, какие инструменты использовать, как взаимодействовать с коллегами, какие существуют основные принципы. Очень полезная статья для технических писателей, которые хотят роста. Начинайте документировать API, разберитесь в этом – и карьерный рост вам обеспечен! Получить первое представление вам поможет эта статья. Автор – Лоис Паттерсон (Lois Patterson), технический писатель API из компании Global Relay (Канада).


Тяжело отследить, сколько раз API (Application Programming Interfaces, интерфейсы программирования приложений) сопровождают нашу жизнь каждый день или даже каждый час. Когда проходит ваша транзакция в PayPal или когда вас подбирает водитель Uber, само по себе API невидимо, и это более чем типично для пользовательского программного обеспечения. API используется даже тогда, когда вы встраиваете YouTube-видео в запись WordPress. При наличии сотен тысяч общедоступных API, доступных широчайшему кругу пользователей, компании находятся под большим давлением, чтобы их API были легки и удобны для использования. Не будет сюрпризом то, что рост количества вакансий, связанных с документированием API, огромен — он показывает разогретый рынок для технических писателей, которые специализируются на документировании API. Читать дальше…


Перевод и локализация. В чем разница?

02.09.2016

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


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


Проблема документирования: является ли структурированный контент залогом значительных улучшений?

24.08.2016

0110 обстоятельств для внедрения DITA на предприятии

Даже сравнительно небольшая компания или организация генерирует множество документов. Когда вы сталкиваетесь с более крупным контекстом, то имеете дело с тысячами или даже миллионами страниц документации, отчётов, маркетинговых материалов, регулярными документами о соответствии законодательству, презентациями… ошеломляющий объем контента. Этот контент со временем станет огромным капиталом и будет рассматриваться как значимое, ценное имущество компании. Почему? Потому что этот контент — ваша первая линия взаимодействия с клиентами, он позволяет таким группам, как HR и поддержка пользователей работать гладко и эффективно, и он представляет собой одновременно интеллектуальную собственность и опыт вашей организации или компании. Но также очень часто он расположен в таких неструктурированных средах для авторинга как файлы Microsoft Word, что делает практически невозможным централизованно управлять этими фондами.


К счастью, есть централизованное решение, основанное на открытых стандартах, масштабируемое и очень экономичное. Построенное на стандарте Darwin Information Typing Architecture (DITA), разработанном IBM для решения их собственных проблем с документацией, это решение представляет собой залог значительных улучшений относительно устаревших моделей создания и управления находящегося в эксплуатации контента, которые сегодня всё ещё широко используются. Когда DITA интегрируется с окружением для авторинга/управления (компонентная система управления контентом, или CCMS), этот стандарт предлагает решение с заделом на будущее решение буквально всех ваших проблем, связанных с управлением документацией. Десять обстоятельств, указанные ниже, показывают масштабируемость, гибкость и значительную экономию средств при переходе на DITA CCMS. Читать дальше…


Стратегические заметки по переносу контента в DITA CCMS

19.08.2016

01Мы возвращаемся к одной из любимых тем – структурированный контент и DITA. Мы уже рассказывали о плюсах структурного подхода к контенту, а сегодня хотим рассмотреть, какие сложности могут вас ожидать при переходе к подобной стратегии.


После того, как вы решите, что разумно было бы управлять контентом в масштабах предприятия, вы столкнётесь с целым рядом острых вопросов, касательно стратегии перехода к структурированному контенту, к примеру, к DITA CCMS. Один из самых важных вопросов – что делать с уже существующим контентом. К сожалению, волшебной кнопки «Перенести всё» не существует. Если учесть разнообразие форматов контента (Word, FrameMaker, PPT, PDF, онлайн-приложения, базы знаний и т.д.) и количество разрозненных мест его хранения (локальные компьютеры, сетевые диски, общие хранилища), перенос контента покажется очень и очень страшным зверем. Но есть и хорошие новости – возможности переработки существующего контента и рабочих процессов всё же существуют. Читать дальше…