Коллеги.

Рады представить вам новую версию программы для быстрой разработки пользовательской документации - Dr.Explain 5.6

Что нового:

• Новый русский файл справки, сразу включенный в установочный пакет.
  Теперь пользователи, работающие в русскоязычном интерфейсе, будут сразу видеть актуальную русскоязычную справку.
  
• Автосохранение проектов
  Ваша работа не пропадет даже в случае внезапного выключения питания.
  
• Якоря (anchors)
  Вставлять именованные якоря в текст и ссылаться на них из других разделов стало очень просто.
  
• Обновленный интерфейс
  Переработанные диалоги функций текстового редактора стали удобнее.
  
• Десятки исправлений и оптимизаций
  Работать станет проще и приятнее.
  

Обновление бесплатно для всех владельцев лицензий версии 5.xx и доступно для установки на странице https://www.drexplain.com/download/


Всегда рады вашим отзывам и предложениям.
Несмотря на отпускной сезон, мы продолжаем работать над очередным обновлением. К осени мы готовим очень крутые штуки.

Продолжаем публикацию серии пользовательских кейсов-примеров использования Dr.Explain в различных компаниях и проектах.



Больше: [Кейсы от русскоязычных пользователей] [Кейсы от международных пользователей]

Продолжаем публикацию серии пользовательских кейсов-примеров использования Dr.Explain в различных компаниях и проектах.



Больше: [Кейсы от русскоязычных пользователей] [Кейсы от международных пользователей]

Продолжаем публикацию серии пользовательских кейсов-примеров использования Dr.Explain в различных компаниях и проектах.



Больше: [Кейсы от русскоязычных пользователей] [Кейсы от международных пользователей]

Продолжаем публикацию серии пользовательских кейсов-примеров использования Dr.Explain в различных компаниях и проектах.



Больше: [Кейсы от русскоязычных пользователей] [Кейсы от международных пользователей]

Начиная с версии 5.5.1100, программа для создания пользовательской  документации Dr.Explain предлагает функцию автоматизированной поддержки  ГОСТ в проектах.

Сейчас реализована поддержка самого востребованного типа документа по ГОСТ 34 - “Руководство пользователя”.  

В частности программа Dr.Explain контролирует и автоматизирует поддержку следующих требований стандартов:  

• Наличие обязательных разделов документа “Руководство пользователя”  [ГОСТ 34 РД 50-34.698-90]. Все разделы снабжаются пояснениями по их  содержанию.
  
• Оформление титульных листов, аннотации и содержания [ГОСТ 19.105-78, 19.104-78].
  
• Параметры печатных страниц документа и расположение основных элементов на них  [ГОСТ 19.106-78].
  
• Структуру и оформление колонтитулов  [ГОСТ 19.106-78].
  
• Оформление текстовой части документа: стили шрифтов, абзацные отступы, межстрочные интервалы  [ГОСТ 19.106-78].
  
• Формирование и оформление заголовков, разделов, перечислений (списков) [ГОСТ 19.106-78].
  

Более подробно о поддержке ГОСТ в Dr.Explain можно прочитать в статье: Разработка руководства пользователя по ГОСТ 34 и ГОСТ 19 в программе Dr.Explain

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

Спасибо.

Начинаем публикацию серии пользовательских кейсов-примеров использования Dr.Explain в различных компаниях и проектах.



Больше: [Кейсы от русскоязычных пользователей] [Кейсы от международных пользователей]

Добрый день,

Некоторые реальные примеры онлайн-справок наших пользователей вы можете посмотреть на этих страницах:

Примеры онлайн-хелпов:
https://www.drexplain.ru/help_authoring_samples/ (RU)
https://www.drexplain.com/help_authoring_samples/  (EN)

Пользовательские кейсы с примерами (не только онлайн-хелпы):
https://www.drexplain.ru/cases/ (RU)
https://www.drexplain.com/cases/ (EN)

Насчет "огненности" - вопрос открыт , но надеюсь, почерпнете какие-то идеи для своей документации.

Возможно, вам также будет интересна статья о том, что нужно учесть при публикации онлайн-справки:
https://www.drexplain.ru/articles/publikuem_onlayn_dokumentatsiyu_na_sayte_proekta­/

Vita,

А вы можете прислать свой проект и все, что к нему прилагается, на help@drexplain.com?
Или выложить куда-то и прислать ссылку.

Спасибо.

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

Vita, добрый день.

Да, удобнее всего вставлять видео, которое размещено на каком-то из перечисленных видео-хостингов.

Однако, есть способ вставить специальный код для проигрывания вашего файла с вашего сервера.
Для  вставки в Dr.Explain  в текстовом редакторе нажмите на панели   инструментов иконку вставки  видео или нажмите комбинацию горячих клавиш   Ctrl+Shift+V. В окне вставки  видео переключитесь в поле вставки кода и   скопируйте в него следующий  текст:

Вариант 1: В HTML  поддерживаются видео .AVI, .WMV и .MP4. Остальные могут  поддерживаться  при наличии установленного плагина (например, QuickTime  или VLC, в  зависимости от браузера).  где "my_cool_video.avi" - название видео файла, расположенного в том же  каталоге, что и HTML. В общем случае там должен быть указан путь к  видеофайлу (абсолютный или относительный).


Вариант 2:  В файлах CHM поддерживаются только видео в формате WMV (возможно, в   последних обновлениях к Internet Explorer были добавлены другие форматы  ). Замените "winsat.wmv" на название нужного видео файла (только название   файла, без пути к нему т.е. "my_video.wmv" вместо   "C:\Users\Jack\Documents\my_video.wmv"). Обратите внимание, что название   нужно указать в двух местах: в
<object data="winsat.wmv"
и в
<param name="filename" value="winsat.wmv" />

Вита,

1) Пришлите, пожалуйста, проблемный документ на help@drexplain.com
2) Сохраняли на сетевой диск или удаленный компьютер? Какой размер файла? Какая у вас версия программы? Сохраняли не в момент выключения Windows?
3) Рядом с файлом документа должен быть файл резервной копии ...gui.bak. Переименуйте его, удалив, расширение .bak, и попробуйте открыть его в программе и продолжить работу с ним.

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

Vita, добрый день.


Аннотированный скриншот можно вставить и в уже существующий раздел.

Также можно аннотировать уже существующее изображение.

Прошу прощения за задержку с ответом на форуме.

Этот запрос мы оперативно отработали еще тогда через тех.поддержку. Сейчас же просто не хочу, чтобы пост оставался без реакции.

Насколько я помню, проблема там была достаточно экзотическая. В системе была сброшена ассоциация HTML или XML файлов с м Internet Explorer. Поэтому вместо их молчаливого открытия через IE и обработку пользователя начинали пытать вопросами, как открыть файл.
В итоге все решилось благополучно.

Спасибо за идеи!

Обязательно обсудим их с командой.

Добрый день.

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

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

Добрый день.

Прошу прощения за задержку с ответом. С форума перестали приходить уведомления о новых темах и постах.

В Dr.Explain есть так называемые Variables (Переменные), хранящие текстовые блоки, которые при итоговой компиляции вставляются в то место, где есть переменная.
Более подробно: http://www.drexplain.ru/help/variables.php  

Друзья, в канун новогодних праздников мы решили немного отвлечься от серьезных проектов и немного пошутить на профессиональную тему.  

Мы с коллегами составили гороскоп технических писателей. В нем мы выделили сильные черты каждого знака Зодиака и попытались понять, как их можно использовать в профессиональном плане.
Узнать, что ближе всего вашему знаку можно на этой странице: http://www.drexplain.ru/technical-writer-zodiac/

С наступающим вас!

Пусть в вашей работе всегда будет место игре и юмору.

С новым годом, коллеги.

Желаем вам интересных проектов и хороших бюджетов на работе, а также красивого и приятного отдыха после нее, и море ярких позитивных впечатлений от жизни.

Коллеги!

Новая статья на нашем сайте:

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

http://www.drexplain.ru/articles/publikuem_onlayn_dokumentatsiyu_na_sayte_proekta­/

Всех с наступающим!

Перевели коротенькую практическую статью с сообщества techwhirl.com.
Статья о простых критериях, по которым можно понять, насколько полезна и пригодна к использованию ваша документация.

10 эвристик для оценки удобства использования (юзабилити) вашей документации
http://www.drexplain.ru/articles/10_evristik_dlya_otsenki_udobstva_ispolzovaniya_­usability_vashey_do...

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

Добрый день, Виктор.
Все так, но до сих пор у этого формата самая универсальная (out of the box) поддержка во всем версиях Windows. Реализация контекстной помощи через HtmlHelp API остается самым простым и "штатным" путем для большинства разработчиков.

16 причин, почему ваши пользователи не читают документацию
http://www.drexplain.ru/articles/pochemu_imenno_vashi_polzovateli_ne_chitayut_dok­umentatsiyu/

Статья не о программе Dr.Explain и вполне подошла бы и для раздела "Введение в специальность" этого форума, но, поскольку в ней все-таки есть упоминание нашего продукта, я счел более корректным разместить ее в "нашем" подфоруме.