Спецификации, ложь и видео: Документальный контроль фильмов

29.07.2016

Один из главных драйверов любой работы – это контроль за её выполнением. А так как «офис без бумажек» пока ещё остаётся утопией, этот самый контроль нужно ещё и задокументировать. А иногда сделать это очень и очень непросто.

Пока я проводил исследования лазил в гугле, чтобы написать эту статью, я пребывал в шоке. В шоке, потому что узнал, что фразы «документальный контроль видео» и «документальный контроль фильмов» в гугле не найти [это явление получило название Googlenopes – прим.пер.]. Ну, правда, нашлось восемь результатов на запрос «контроль версий видео», но (а) восемь результатов во всем Интернете – это даже не смешно и (б) контроль версий и документальный контроль – не одно и то же. Контроль версий означает, что версия Б хранится отдельно от версии А. А документальный контроль означает (среди многого другого), что все мои пользователи используют версию Б видео, и ни один из них не использует версию A. Читать дальше…

Сравнение популярных редакторов для совместной работы над технической документацией: MadCap Flare, EasyDITA, Dr.Explain

21.07.2016

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

Введение

В статье мы расскажем о трёх популярных продуктах для совместной работы над технической документацией: MadCap Flare, EasyDITA и Dr.Explain. Каждый из них в той или иной степени реализует принципы единого источника: повторное использование контента и его отделение от форматирования, публикация в различные форматы из одного проекта-источника. Эти принципы существенно экономят время разработки документации и помогают поддерживать единый стиль текста.

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

Первый «Доквариум» пройдёт 28 июля

20.07.2016

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

За последнее время мы уже сделали несколько шагов для исправления ситуации: создали учебный курс, в котором много времени отводится на общение с преподавателем, ведём блог с полезными материалами и периодически организуем конференции. Но при этом «живого» общения всё равно остаётся очень мало, поэтому сейчас мы решили сделать ещё один шаг навстречу коммуникациям.

Итак, мы объявляем о создании площадки для общения и обмена опытом между техническими писателями! И называется она «Доквариум». Читать дальше…

Адвокат пользователя: лучше приносить пользу, а не внушать восхищение

15.07.2016

Сегодня мы представим вам нового автора уже известного нам цикла статей «Адвокат пользователя». Фил Девис всю жизнь работает над тем, чтобы улучшить жизнь пользователей и решил поделиться некоторыми наблюдениями.

В «Адвокате пользователя» всё меняется. Нила завалили требованиями графиков запуска и конференц-презентаций. Я мог бы весь день читать его остроумные анализы, но теперь моя очередь добавить что-то к вдумчивой, проницательной практической многолетней  работе Джеффа, Марка и Нила.

Так кто же этот новый парень? Я не собираюсь занимать чьё-то место и не могу утверждать, что буду идейным лидером или гуру. Я работал в качестве технического писателя 20 лет. Я начал в сфере аппаратных средств, программного обеспечения, руководил командой писателей, и теперь я сольный писатель и отвечаю за производство документации, интеграцию и распределение продуктов более 10 лет, API – более 12 лет, и заказных фирменных решений для оценки ребрендинга клиентов по всему миру, а также играю свою роль во внутренних и внешних релизах. Читать дальше…

На заметку руководителю: помогаем членам команды развиваться

07.07.2016

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

Я на днях прочитала пост с заголовком «Когда хорошо НЕ развиваться? Подсказка: Никогда«. Я сразу подумала: «Ну, конечно же, мы всегда должны учиться». Я стала читать дальше и поняла, что не всегда выполняю свои обязанности лидера и не помогаю моим сотрудникам профессионально развиваться. Читайте дальше, чтобы узнать, почему, и как я планирую исправиться.

Что подразумевается под профессиональным развитием?

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

Алгоритм повторного использования

30.06.2016

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

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

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

Повторное использование контента — это не один метод, а коллекция из множества методов. Поэтому существует несколько алгоритмов повторного использования, каждый из которых требует особых структур контента в доменах объекта и документа.

Самый простой метод повторного использования контента — вырезать и вставить контент из одного источника в другой. Этот подход быстр и лёгок в применении, но приводит к куче проблем управления. Так что когда люди говорят о повторном использовании контента, они обычно имеют в виду любое и каждое из значений повторного использования контента, кроме вырезки и вставки. Читать дальше…

Применение продуктов MadCap Software на отечественном софтверном производстве на примере компании АСКОН

23.06.2016

Сегодня мы публикуем рассказ одного из наших клиентов – Анастасии Тян, технического писателя из компании АСКОН – об их опыте использования продукта MadCap Flare и Lingo. Этими продуктами в компании начали пользоваться ещё до того, как компания ПроТекст стала партнёром MadCap Software, и пользуется по сей день, не забывая обновлять их до актуальных версий, чтобы задействовать все преимущества программного обеспечения.

АСКОН — крупнейший российский разработчик инженерного программного обеспечения и интегратор в сфере автоматизации проектной и производственной деятельности. В продуктах компании воплощены достижения отечественной математической школы, 26-летний опыт создания САПР и глубокая экспертиза в области проектирования и управления инженерными данными в машиностроении и строительстве. Программное обеспечение АСКОН используют свыше 9000 промышленных предприятий и проектных организаций в России и за рубежом.

В АСКОН MadCap Flare используется для написания и оформления справочной документации к новым продуктам —  к системе информационного моделирования Renga Architecture (справка) и системе управления проектированием Pilot-ICE (справка). Читать дальше…

Microsoft запускает новый сайт документации, и он весьма неплох

15.06.2016

Компания Microsoft со своим знаменитым Гидом по стилю, удобным сайтом, исчерпывающей справкой к продуктам для многих является примером для подражания. В прошлом месяце они запустили новый сайт, посвящённый именно тому, что нас интересует – документации. Давайте взглянем на него подробнее.

Microsoft анонсировала предварительный релиз своего сайта документации, https://docs.microsoft.com, который в настоящий момент предлагает контент, посвящённый своим мобильным решениям (Enterprise Mobility).

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

Представляем MadCap Lingo 10

09.06.2016

1 июня 2016 года компания MadCap Software выпустила новую версию своего инструмента для переводчиков и локализаторов — MadCap Lingo 10. В связи с этим с 1 по 30 июня действует специальное ценовое предложение от производителя, условия которого можно узнать в нашем магазине. Рассмотрим далее преимущества, которые стали доступны в новой версии этого продукта.

Новая интеграция с производственными процессами MadCap Flare 12

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

Алгоритм единого источника

29.05.2016

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

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

Единый источник был одной из первых мотиваций к структурированному писательству. Однако термин «единый источник» по привычке означает различные вещи, каждая из которых связана так или иначе с единым источником, но их используют разные подходы, что приводит к разным результатам. Чтобы упростить себе жизнь, я разделяю следующие три основных значения единого источника:

• Единый источник: Представление одного документа на различных носителях.
• Повторное использование контента: Использование одного контента для создания различных документов.
• Единый источник правды: Гарантия того, что каждая часть информации записана только единожды.

В этой статье мы рассмотрим единый источник так, как это определено выше. Читать дальше…