БЛОГ
Как правильно выделять элементы текста в документации
01.12.2016Кирилл Богатов, технический писатель ГК «Системные Технологии», делится своим советом с техническими писателями. Собственно, по опыту нашей работы, начинающие технические писатели достаточно часто не используют описанную возможность форматирования технической документации, де-факто уже ставшей негласным стандартом.
Программисты часто используют редакторы с подсветкой синтаксиса. Это помогает быстро ориентироваться в коде. Всё просто: есть язык разметки, по которому программа однозначно определяет переменные и раскрашивает их соответствующими цветами.
Sublime Text с подсветкой синтаксиса
Отчёт о Доквариуме №2 «Видеодокументация»
29.11.2016
23 ноября прошёл второй Доквариум, посвящённый теме «Видеодокументация».
На наш взгляд встреча получилась ну очень интересной! От специалистов, которые уже много лет создают и публикуют видеоинструкции и маркетинговые материалы в виде видеороликов, мы узнали:
- стоит ли вообще снимать видео (конечно стоит, интриги тут нет 🙂 . А вот почему именно – мы и узнали из докладов)
- как снимать видео – пошаговый процесс создания ролика, от сценария до монтажа
- какие бывают типы видеодокументации
- какова оптимальная длина видороликов для разных типов задач
- где размещать видеоконтент
- как собирать статистику использования видеоконтента
- как видеоролики помогают увеличивать прибыль и снизить затраты
А также:
- какими инструментами пользуются сами докладчики
- лайфхаки «из первых рук»
- ошибки, через которые пришлось пройти нашим докладчикам, чтобы наработать мастерство
- ответы на многие другие вопросы!
Огромное спасибо докладчикам за выступления и участникам за активность и интересные вопросы!
Программа:
- Использование формата видео для технической информации
Павел Семёнов, аналитик, АО «СберТех», г. Новосибирск
- Снимать или не снимать? (Обучающие видео как один из типов контента для поддержки пользователей)
Мария Большакова, руководитель отдела обмена знаниями, Марина Соболевская, руководитель группы веб-контента, Лабораторая Касперского, г. Москва
- Видеоинструкции: от сценария до публикации
Алексей Мартин, руководитель учебного центра Naumen Contact Center, г. Москва
- Ответы докладчиков на вопросы участников
Для всех, кто не был, мы предоставляем запись Доквариума. Будем рады, если информация окажется вам полезной! И ещё нас очень порадует, если напишите нам пару слов обратной связи – здесь в комментариях или на адрес: info@protext.su 🙂
А если вы решили начать разрабатывать видеоинструкции для вашего продукта и хотите доверить этот процесс подрядчику – обращайтесь к нам!
Алгоритмы структурированного писательства в процессе публикации
17.11.2016
Статья входит в цикл «Понимание и применение структурированного писательства».
Всё структурированное писательство в конечном итоге должно быть опубликовано. Публикация структурированного контента — это преобразование его из домена, в котором оно было создано (домен объекта, домен документа или абстрактная часть домена носителя), в наиболее определённую часть спектра домена носителя: точки на бумаге или на экране.
Почти во всех инструментах структурированного писательства этот процесс совершается в несколько шагов. Использование нескольких шагов упрощает написание и поддержку кода, а также повторное использование кода для множества целей.
В этой статье я определяю публикацию как процесс, состоящий из четырёх основных алгоритмов, которые я упоминал мимоходом в предыдущих статьях: алгоритмы синтеза, представления, форматирования и кодирования. Это модель процесса публикации. Все процессы в этой модели должны где-то совершаться в каждом реальном процессе публикации, но организация этих процессов может подразделяться или иметь последовательность отличную от этой модели. Я формализовал эти четыре этапа в архитектуре SPFE (о которой подробнее расскажу позже), но думаю, что они являются достоверным представлением того, что происходит в большинстве цепочек инструментов для публикации. Чтобы понять требования каждого этапа и влияние на структурированное писательство, давайте посмотрим на процесс от финального вывода обратно к созданию и синтезу. Читать дальше…
Доквариум №2
10.11.2016
Дорогие друзья, приглашаем вас на второй Доквариум!
Тема: ВИДЕОДОКУМЕНТАЦИЯ – эта тема собрала большинство заявок на прошлом вебинаре.
Дата и время: 23 ноября, начало в 16:00 по московскому времени.
Ориентировочная продолжительность: 2 часа.
Адаптация документов к требованиям ГОСТ с помощью MadCap Flare 12
09.11.2016
Оформить документ по ГОСТ автоматически? В MadCap Flare — легко! Представляем вашему вниманию статью Павла Сапожникова, профессионального технического писателя, активно использующего в своей работе современные технологии документирования. Данная статья посвящена оформлению комплектов документов по российским стандартам в MadCap Flare, при этом изложенные в ней рекомендации могут по аналогии применяться и в других современных профессиональных инструментах для документирования.
Большинство софтверных компаний российского IT-рынка придерживаются собственного корпоративного стиля оформления документации на разрабатываемые программные продукты. Кажется, что строгие конструкторские рамки, шрифт Times New Roman, и прочие требования ГОСТ уже давно канули в лету. Да и у современного пользователя вид User Guide, оформленного по всем канонам ГОСТ19 и ГОСТ34, вызовет разве что недоумение.
Тем не менее, российский IT-рынок специфичен и местами консервативен. Здесь до сих пор встречается требовательный заказчик в лице государственных структур, для которого приходится соблюдать некоторые нормы ГОСТ. Читать дальше…
Представляем MadCap Central (бета)
03.11.2016
27 октября компания MadCap Software сообщила о появлении нового, на этот раз облачного продукта — MadCap Central. Также компания выпустила новый релиз своего флагманского продукта MadCap Flare 2016 r2, одновременно объявив о переходе на эджайл-менаханизм разработки с более частыми релизами и удалении в связи с этим номеров версий продуктов из своего прайс-листа. Представляем перевод соответствующего пресс-релиза, а подробное описание возможностей продукта вы найдёте в нашем интернет-магазине.
Расширьте ваши возможности авторинга с помощью инструмента для облачного управления контентом MadCap Central
Повысьте качество контента, глубже вникните в задачи и производственные планы, работайте совместно с командами и отделами, а также автоматизируйте процессы для дальнейшего расширения возможностей MadCap Flare для авторинга и публикаций.
MadCap Central сейчас находится в состоянии публичной беты, предоставляя бесплатно полную функциональность на расширенный период времени. Весь контент, хранящийся во время бета-тестирования, будет доступен после бета-периода, если вы решите приобрести подписку.
Управляйте проектами и контентом в одном централизованном месте
Инструменты совместной работы над документацией
30.10.2016Представляем вашему вниманию презентацию Екатерины Носковой, слушательницы курса для технических писателей компании «Протекст». Она посвящена инструментам совместной работы над документацией и сравнению некоторых из них.
Примечание. 27 октября компания MadCap Software заявила о доступности бета-версии своего нового облачного сервиса для управления контентом MadCap Central. Этот факт не отражен в данной презентации, информация об этом новом продукте в ближайшее время появится на нашем сайте.
Качество писательства никогда не сможет быть лучше качества исследования
21.10.2016
Допустим, написанный автором материал оказался невысокого качества. Как определить, в чём причина: материал плохо написан или всё же автор не до конца разобрался с предметом?
От редактора: Следующая статья написана Германом Хольтцем (Herman Holtz) является частью «классической» коллекции статей, которые прошли проверку времени, независимо от того, сколько появилось и ещё появится новых технологий.
Большинство из нас, вероятно, имеет некоторые представления о том, что такое хорошее, а что такое плохое писательство, и вероятно, большинство из нас измеряют или судят писательство посредством различных стандартов, которые, как нам кажется подходят для измерения качества. Однако правда заключается в том, что качество — характеристика эфемерная и отличается для каждого вида писательства. Допустим, я прочитал книгу, которую кто-то считает отличной прозой, но она оказывалось довольно унылой. Но причина этого может быть в том, что мне не нравится жанр — некоторая часть научной фантастики мне не нравилась, например, вообще — и я не мог высказывать мысли о том, каким должно быть хорошее писательство в этом жанре, потому что я в принципе не мог понять, почему у меня возникают такие ощущения. С другой стороны, моя собственная работа (и собственные успехи) касались в основном выработки рекомендаций о том, как писать, и поэтому я оттачивал мнение о качестве писательства в виде советов по каждому вопросу. Читать дальше…
Чат гендиректоров: Будущее контента с Майклом Розински
14.10.2016
Сегодня мы обсуждаем будущее контента с Майклом Розински (Michael Rosinski), генеральным директором Astoria Software, облачной компонентной системы управления контентом (CCMS). Розински, ветеран области управления контентом, разговаривает со Скоттом Абелем (Scott Abel), The Content Wrangler, об инновациях, информационных технологиях и о том, как искусственный интеллект повлияет на контент и тех, кто его производит.
Скотт: Майкл, вы человек, окружённый технологиями круглосуточно – ставлю, что вы видите здравый смысл в грядущих больших изменениях. Помогите нам разобраться. Как гендиректор технологической компании, что вы считаете наиболее захватывающими инновациями в плоскости контента?
Майкл: Отличный вопрос. Я верю, что наиболее захватывающая инновация в мире контента – когнитивные информационные технологии. Почему? Потому что традиционные информационные технологии хотя и впечатляющие, в то же время несколько идиотские. Нынешнее программное обеспечение для компьютеров может составлять таблицы и вычислять, хранить, управлять и доставлять файлы быстрее человека. И несмотря на то, что компьютеры намного лучше запоминают детали, они не могут предоставлять многие возможности относительно контента, необходимые современным компаниям. Однако вскоре это изменится. Читать дальше…
Atlassian Confluence в качестве среды для создания технической документации
07.10.2016
Предлагаем Вашему вниманию статью слушателя нашего курса «Разработка технических текстов и документации» Георгия Полищука, посвящённую одной из наиболее популярных платформ для организации совместной работы над информацией Atlassian Confluence, которую часто используют в том числе для организации процессов документирования.
Содержание
КРАТКО О ПРИНЦИПАХ РАБОТЫ CONFLUENCE
Экспорт документации в файлы MS Word
Создание единой структуры требования для ее использования в нескольких документах
Создание эксплуатационной документации для различных версий продукта
Создание «динамических» отчетов
Еще несколько полезных плагинов
Введение
Австралийская компания Atlassian известна своими программными продуктами для управления проектами разработки программного обеспечения. Широкую популярность завоевали инструмент управления проектами и баг-трекер JIRA, а также система совместной работы над информацией Confluence. Читать дальше…