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

БЛОГ

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

07.07.2016

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


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

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

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


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

30.06.2016

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

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


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

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

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


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

23.06.2016

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


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

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


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

15.06.2016

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


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

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


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

09.06.2016

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


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

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


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

29.05.2016

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

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


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

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

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


Почему люди забывают наш контент (и что с этим делать)

20.05.2016

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


Почему люди забывают наш контент?

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


Дефицит талантов в контент-индустрии. Что можно с этим сделать?

13.05.2016

Female Designer Working At Desk In Modern OfficeЛюбая компания сталкивалась с проблемой подбора сотрудников. И если найти грамотного юриста или экономиста хоть и проблематично, но вполне реально, то подобрать специалиста по работе с контентом иногда бывает просто невозможно. В чём причина? В том, что таких специалистов попросту не существует. За рубежом ситуация уже понемногу выравнивается, но в России эта сфера начала развиваться гораздо позже и сталкивается с куда более многочисленными трудностями.

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

Поняли, что в последнее время взвалили на себя дополнительные обязанности по работе с контентом? Вынуждены изучать новые приложения, информационные панели, шаблоны и языки разметки, чего в описании работы не было? Обратили внимание, что в офисе больше пустых столов, чем обычно? Читать дальше…


Адвокат пользователя. Осторожнее со словами

05.05.2016

05.05.16Нил Каплан, автор серии «Адвокат пользователя», отличается от многих технических писателей тем, что пишет не для компании, не для того, чтобы просто что-то написать, а для своего пользователя. Клиентоориентированность сегодня стоит во главе угла любого бизнеса, поэтому предлагаем ознакомиться – а в идеале и перенять – некоторые из принципов такого подхода.


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


Быстрый, простой и доступный способ инвентаризации веб-контента

29.04.2016

Hands on keyboardСегодня мы хотим затронуть глобальную проблему количества и качества веб-контента. Наша публикация относится не только к техническим писателям, переводчикам или предметным специалистам, но касается любого, у кого есть сайт и кто хочет, чтобы этот сайт работал.

Аудит Вашего контента или любой технической документации Вы можете заказать у специалистов компании ПроТекст. А базовый аудит одного документа мы делаем бесплатно.

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

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