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

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

Как правильно выделять элементы текста в документации

01.12.2016

Кирилл Богатов, технический писатель ГК «Системные Технологии», делится своим советом с техническими писателями. Собственно, по опыту нашей работы, начинающие технические писатели достаточно часто не используют описанную возможность форматирования технической документации, де-факто уже ставшей негласным стандартом.


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

 

8021_600Sublime Text с подсветкой синтаксиса

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



Адаптация документов к требованиям ГОСТ с помощью MadCap Flare 12

09.11.2016

coverОформить документ по ГОСТ автоматически? В MadCap Flare — легко! Представляем вашему вниманию статью Павла Сапожникова, профессионального технического писателя, активно использующего в своей работе современные технологии документирования. Данная статья посвящена оформлению комплектов документов по российским стандартам в MadCap Flare, при этом изложенные в ней рекомендации могут по аналогии применяться и в других современных профессиональных инструментах для документирования.

У Вас ещё нет этого полезного софта? Не хотите долго возиться с документами, а потом мучиться с приёмкой в госкомиссии? Поможем Вам разработать комплекты документации по ГОСТ на аутсорсе. Обращайтесь! 🙂

Большинство софтверных компаний российского IT-рынка придерживаются собственного корпоративного стиля оформления документации на разрабатываемые программные продукты. Кажется, что строгие конструкторские рамки, шрифт Times New Roman, и прочие требования ГОСТ уже давно канули в лету. Да и у современного пользователя вид User Guide, оформленного по всем канонам ГОСТ19 и ГОСТ34, вызовет разве что недоумение.

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



Как коммуникаторы используют Doc-To-Help

07.10.2015

00Недавно в нашем магазине появилась возможность приобрести продукт для создания контента Doc-To-Help, который совместим с Microsoft Word. Мы писали о возможностях данного софта для технических писателей, а сегодня расскажем о его особенностях в контексте различных форматов и типов документов.


 

Основанное на Word простое в использовании решение для создания, управления и публикации онлайн-справок, руководств и методик, электронных книг и другой документации

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



Когда вашей документации требуются скриншоты?

30.09.2015

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


Один из частых вопросов при разработке документации: «Сколько скриншотов она должна включать?» Ответы разнятся от «Ни одного!» до «Все окна!». Картинка может заменить тысячи слов, но скриншоты часто используются в качестве «костыля» для некачественной документации или некачественного дизайна. Лучший ответ — использовать их там, где необходимо, и не использовать в других случаях. Но как узнать, когда они необходимы? Читать дальше…



Встречайте Doc-To-Help

18.09.2015

00Используйте Doc-To-Help совместно с Microsoft® Word для производства онлайн-документации, веб-контента, контента для мобильных устройств, электронных книг или вывода на печать. Пишите свой контент единожды, и публикуйте в любых форматах и местах с Doc-To-Help.

Авторинг и публикация с помощью Microsoft® Word

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

  • Избавьте контент из заточения в Microsoft® Word™ и преобразуйте его в любой формат вывода
  • Создавайте документы в привычной среде с помощью Word и используйте уже имеющийся контент
  • Быстро и просто создавайте учебники, руководства пользователя, базы знаний и многое другое
  • Публикуйте во множество форматов вывода, включая отзывчивый веб-формат, PDF, ePub и другие форматы
  • Используйте уже имеющийся контент с помощью функций простого импорта
  • Используйте профессиональные встроенные темы вывода или настройте собственную
  • Поддержка множества языков, интеграция с MadCap Lingo
  • Используйте условные тэги, чтобы составить карту контента для вывода в разные форматы
  • Улучшите контроль над источниками и совместную работу
  • Экономьте время, позволив Doc-To-Help делать работу для вас

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



Как структурировать объёмный текст

16.09.2015

Часто говорят о том, что нужно писать как можно короче, убирать лишнее, что никто не читает большие тексты и т.д. и т.п. Но как быть, если ваша история не помещается в тесные рамки минимализма? В статье несколько советов о том, как написать объёмный пост или какой-либо другой текст так, чтобы он не вызывал реакцию «слишком-многобукв-не-буду-читать». Автор текста: Скотт Несбитт (Scott Nesbitt).


Толпа адептов TLDR (too long, didn’t read; слишком длинно, не читал) сейчас удивится, но… в Интернете есть место для текстов крупных форм. И в печати тоже.

Я не буду подробно рассказывать, почему крупные формы важны — это тема другого поста в другое время. Если у вас есть интересная история, то нет причин, по которым вы не можете занять немного больше времени, немного больше места и чуть больше слов, чтобы рассказать её. Читать дальше…



Самый быстрый способ получить настраиваемый скриншот

12.09.2014

12.09.14Представляем вам обзор простого, но очень полезного приложения. Оно представляет собой аналог стандартного инструмента Windows «Ножницы», но с дополнительными функциями и горячими клавишами. А для пользователей Mac, где подобного инструмента нет, это приложение незаменимо.


 

Мы хотели бы поделиться с вами одной из наших любимых игрушек. Это бесплатный инструмент для создания скриншотов LightShot. Скачать его можно здесь http://app.prntscr.com. Это штука оказалась чрезвычайно полезной и интересной благодаря нескольким функциям:

Возможность поделиться скриншотами через Интернет

Вы ведь хотите делиться с друзьями фотографиями, картинками, веб-страницами или любым другим контентом? Просто запустите Lightshot, нажав клавишу Print Screen, выберите область и нажмите Upload (Загрузить). Вы получите ссылку, которой можно поделиться с друзьями, запостить в блоге, Twitter, Facebook… да где угодно! Читать дальше…



Преобразуем оригинальный дизайн в шаблон бланка Microsoft Word

18.08.2014

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

Хотите научиться разнообразным фишкам MS Word и других программ, изучить теорию по разработке технических текстов и приобрести практические навыки? Всё это Вы получите, освоив курс «Разработка технических текстов и документации».

В конце проекта с оригинальным дизайном довольно часто приходится слышать от клиентов: «Я хочу получить редактируемый шаблон этого бланка в Microsoft Word». Они, как правило, не устанавливают и не знают, как использовать передовые программы графического редактирования, такие как Adobe Illustrator, InDesign или Photoshop, и им просто нет смысла приобретать эти дорогостоящие программы.

Microsoft Word включает довольно примитивные технологии по сравнению с Illustrator или InDesign; однако, именно его используют клиенты, и ваш фирменный бланк бесполезен, если они не смогут редактировать и добавлять в него контент, поэтому умение создавать шаблоны бланков Microsoft Word является ключевым. Давайте начнем. Читать дальше…



Встречайте MadCap Mimic и MadCap Capture

23.06.2014

00Сегодня мы продолжим знакомить вас с продуктами компании MadCap Software. MadCap Mimic и MadCap Capture – инструменты для работы с мультимедиа. С ними можно легко создавать видеоролики, симуляторы программного обеспечения и делать качественные скриншоты с необходимой обработкой, причём обновлять всё это будет легко и быстро, т.к. продукты основаны на технологии единого источника. Обновите, например, ссылки и номер версии продукта в рабочем проекте, и они автоматически обновятся в видеороликах и на скриншотах сразу во всех форматах, в которые вы выводили свой проект. Не правда ли, это похоже на чудо? Кстати, все ролики и рисунки на сайте www.madcapsoftware.com были сделаны с помощью этих продуктов.


 

MadCap Mimic

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



Встречайте MadCap Lingo

16.06.2014

00MadCap Lingo представляет собой программный инструмент, предназначенный для помощи техническим писателям, специалистам по документации и профессиональным переводчикам в процессе перевода. Повышает эффективность перевода, поддерживая переводческую память, управление терминологией, возможности создания подробных отчётов и многое другое.


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

MadCap Lingo является первым полностью интегрированным инструментом для автоматизированного перевода (CAT – computer-aided translation) и управления рабочим процессом, разработанный для автономного использования либо работы совместно с MadCap Flare для оптимизации процесса перевода.

Решение для оптимизации рабочего процесса для авторов и специалистов по документации

  • Улучшенный рабочий процесс и возможности рецензирования для команд, работающих с документацией, и переводчиков
  • Легко упаковать и отправить контент с Упаковщиком Проекта (Project Packager)
  • Обеспечивает целостность проекта и устраняет риск повреждения контента и форматирования
  • Отчёты по статистике, прозрачность процесса перевода и расходов
  • Расширенные функции, такие как конвертирование переменных в текст

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