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

Новости о техническом писательстве

Итак, вам нужно документировать 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, онлайн-приложения, базы знаний и т.д.) и количество разрозненных мест его хранения (локальные компьютеры, сетевые диски, общие хранилища), перенос контента покажется очень и очень страшным зверем. Но есть и хорошие новости – возможности переработки существующего контента и рабочих процессов всё же существуют. Читать дальше…



Как использовать Google Analytics для наполнения сайта

12.08.2016

01На прошлой неделе мы писали о том, зачем вообще техническому писателю разбираться в Google Analytics. Сегодня мы расскажем о плюсах использования этого инструмента на частном примере – наполнение и продвижение сайта.

Вы задумываетесь о создании блога своей компании, но не знаете, кто бы писал для него материалы? Наши специалисты с удовольствием помогут Вам!

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

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



Зачем техническому писателю разбираться в Google Analytics

05.08.2016

09Маркетинг сегодня вышел на первый план. Нужно не только создать продукт, но и суметь его продать. То же самое относится и к контенту. Каким бы великолепным ни был документ, он бессмыслен, если аудитория его не увидит. Помочь нам понять, что хочет аудитория и в каком виде она хочет это получить, призваны различные инструменты аналитики. Сегодня мы поговорим о самом популярном из них – Google Analytics, и узнаем, зачем необходимо уметь разбираться в нём. А в следующем посте нашего блога вы найдёте информацию о том, как писателю использовать Google Analytics для лучшей веб-документации.


План контент-маркетинга, который призван обеспечивать рентабельность инвестиций, частично состоит из творческого вдохновения, а частично из фактов и здравого смысла. Было бы неразумно выбрать направление с чёткой ориентацией на цели без глубокого понимания критериев анализа. Это значит, что вашим стратегам абсолютно необходимо разбираться в Google Analytics. Именно квалифицированных консультантов по аналитике большинство компаний ищут в контент-маркетинговых агентствах. Мы считаем, что сильная команда по контент-маркетингу предоставляет данные аналитики каждому из заинтересованных участников проекта. Читать дальше…



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

29.07.2016

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


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



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

21.07.2016

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


Введение

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

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



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

15.07.2016

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


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

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



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

07.07.2016

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


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

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

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