Создание справки и документации
От: Submitter  
Дата: 01.02.18 04:39
Оценка:
Какой вы видите программу, создающую справку к чему-либо или документацию?
Чем вы создаете справку для своих программ (не считая чистого HTML) и какую программу вы бы хотели? Что она должна уметь?
Re: Создание справки и документации
От: kov_serg Россия  
Дата: 01.02.18 04:41
Оценка: +1
Здравствуйте, Submitter, Вы писали:

S>Какой вы видите программу, создающую справку к чему-либо или документацию?

S>Чем вы создаете справку для своих программ (не считая чистого HTML) и какую программу вы бы хотели? Что она должна уметь?
Пока самая симпатишная справка получается в chm.
Re[2]: Создание справки и документации
От: Submitter  
Дата: 01.02.18 04:45
Оценка: :)
Здравствуйте, kov_serg, Вы писали:

S>>Какой вы видите программу, создающую справку к чему-либо или документацию?

S>>Чем вы создаете справку для своих программ (не считая чистого HTML) и какую программу вы бы хотели? Что она должна уметь?
_>Пока самая симпатишная справка получается в chm.

Это же очень сильно устарело. Помню лет 10-12 был Microsoft Work Shop (или как-то так), но это же очень устарело?
Re: Создание справки и документации
От: Lazytech Ниоткуда  
Дата: 01.02.18 05:02
Оценка:
Здравствуйте, Submitter, Вы писали:

S>Какой вы видите программу, создающую справку к чему-либо или документацию?

S>Чем вы создаете справку для своих программ (не считая чистого HTML) и какую программу вы бы хотели? Что она должна уметь?

Тут на форуме иногда появляется разработчик одной такой программы.
Re[3]: Создание справки и документации
От: Lazytech Ниоткуда  
Дата: 01.02.18 05:05
Оценка:
Здравствуйте, Submitter, Вы писали:

_>>Пока самая симпатишная справка получается в chm.

S>Это же очень сильно устарело. [skip]

А что не устарело? PDF, что ли?
Re[2]: Создание справки и документации
От: Submitter  
Дата: 01.02.18 05:09
Оценка: +1
Здравствуйте, Lazytech, Вы писали:

L>Тут на форуме иногда появляется разработчик одной такой программы.


DrExplain? Все руки не дойдут скачать и посмотреть.
Re: Создание справки и документации
От: kov_serg Россия  
Дата: 01.02.18 05:12
Оценка:
Здравствуйте, Submitter, Вы писали:

S>Какой вы видите программу, создающую справку к чему-либо или документацию?

простой исходный формат + шаблоны + скрипты (для параметризации, переводов и доводки текстов) + утилиты для преобразований текстов (из javadoc, doxugen и т.п)
и потом генерить chm, epub/fb2, pdf (a4,a5...), man, tex.
А если еще и вменяемый редактор, что бы обычные учителя могли электронные учебники делать, было бы замечательно.

S>Чем вы создаете справку для своих программ (не считая чистого HTML) и какую программу вы бы хотели? Что она должна уметь?

Должна быть копактной, не требовательной, без зависимостей и работать от xp до linux
Re[2]: Создание справки и документации
От: Lazytech Ниоткуда  
Дата: 01.02.18 06:00
Оценка: +2
Здравствуйте, kov_serg, Вы писали:

_>простой исходный формат + шаблоны + скрипты (для параметризации, переводов и доводки текстов) + утилиты для преобразований текстов (из javadoc, doxugen и т.п)

_>и потом генерить chm, epub/fb2, pdf (a4,a5...), man, tex.

Ничего не имею против таких форматов, как epub/fb2 и pdf, но в таких документах зачастую трудно что-то найти. То есть функция поиска есть, но вот как она работает... Особенно это касается документов PDF, содержащих сотни страниц.

P.S. Поправка: частично снимаю претензию к формату FB2, поскольку там поиск идет достаточно быстро. Но всё равно искать не очень удобно, поскольку там достаточно тупой поиск, примерно как в Блокноте.

P.P.S. Кстати, поиск по документу PDF иногда не находит даже те словосочетания, которые в нем точно есть, из-за жесткого переноса на следующую строку.
Отредактировано 01.02.2018 9:24 Lazytech . Предыдущая версия . Еще …
Отредактировано 01.02.2018 9:21 Lazytech . Предыдущая версия .
Отредактировано 01.02.2018 6:07 Lazytech . Предыдущая версия .
Отредактировано 01.02.2018 6:02 Lazytech . Предыдущая версия .
Re[3]: Создание справки и документации
От: Qt-Coder  
Дата: 01.02.18 07:50
Оценка: +1
Здравствуйте, Submitter, Вы писали:

S>DrExplain? Все руки не дойдут скачать и посмотреть.

Типичная ошибка — начинать разработку не изучив конкурентов.
Re: Создание справки и документации
От: Unhandled_Exception Россия  
Дата: 01.02.18 08:46
Оценка:
Здравствуйте, Submitter, Вы писали:

S>Чем вы создаете справку для своих программ (не считая чистого HTML) и какую программу вы бы хотели? Что она должна уметь?


Я стал использовать https://dotnet.github.io/docfx/, немного поправил шаблоны и добавил скриптов, чтобы генерировался chm. В результате автоматом получаю html файлы для сайта, chm файл для программы и вдобавок pdf для любителей.

И все бесплатно.

Так-то, наверное, можно в этой нише развернуться. К примеру, есть задача: меняется интерфейс программы, поэтому надо переделать такие-то и такие-то скриншоты. Вот бы это автоматизировать. Может, конечно, и есть уже решение.
Re[2]: Создание справки и документации
От: sharez  
Дата: 01.02.18 09:06
Оценка:
Здравствуйте, Unhandled_Exception, Вы писали:

U_E>Так-то, наверное, можно в этой нише развернуться. К примеру, есть задача: меняется интерфейс программы, поэтому надо переделать такие-то и такие-то скриншоты. Вот бы это автоматизировать. Может, конечно, и есть уже решение.


Про создание скриншотов неистово плюсую.

Я сам писал велосипед, и пользуюсь им. Но не хватает функционала, например, между первым и вторым скриншотом надо произвести какие-то действия в приложении, с которого снимаем скриншоты, и сейчас моя софтина-скриншотоснималка умеет только вывести надпись "выполните действие Х, и нажмите на Далее", что неудобно. Нужна программа, которая сама может кликать по нужным элементам, выдерживать паузы, если надо, и снимать скриншоты. И, конечно, удобный редактор этих сценариев — чтобы там был и свой язык и отдельное GUI для его правки без лазинья в блокнот.

Программа нужна как отдельная программ-скриншотоснималка, в открыве от программы-документировалки.
Если будет хорошее решение, готов купить лицензию за $99.
Re: Создание справки и документации
От: rean  
Дата: 01.02.18 09:36
Оценка:
deleted
Отредактировано 22.04.2019 9:26 deleted2 . Предыдущая версия .
Re[2]: Создание справки и документации
От: Submitter  
Дата: 01.02.18 09:37
Оценка:
Здравствуйте, rean, Вы писали:

R>Справка не нужна. Браузер есть же.


А зачем тогда используют PDF, CHM и другие форматы? "Браузер есть же".
Re: Создание справки и документации
От: Matrix_Failure http://matrixfailure.wordpress.com/
Дата: 01.02.18 09:54
Оценка:
Здравствуйте, Submitter, Вы писали:

S>Чем вы создаете справку для своих программ (не считая чистого HTML) и какую программу вы бы хотели? Что она должна уметь?


Мы перешли на Dr.Explain
https://www.drexplain.ru/

Он устраивает всем.

В нем есть автоматическая генерация скриншотов и автоматизирвоанное описание GUI.

Что мы поставляем клиентам:

CHM — в дистрибутив, если у клиента нет инернета (например в командировке).
PDF — высылаем по запросу клиентов (такие регулярно бывают).
HTML — на сайт — обязательно и очень удобно для тех.поддержки давать ссылки на конкретные ответы и главы.

Вот полный комплект который мы используем.
Отредактировано 01.02.2018 10:03 Matrix_Failure . Предыдущая версия .
Re[2]: Создание справки и документации
От: Submitter  
Дата: 01.02.18 10:04
Оценка:
Здравствуйте, Matrix_Failure, Вы писали:

M_F>Мы перешли на Dr.Explain

M_F>https://www.drexplain.ru/

M_F>Он устраивает всем.


Конкурентов смотрели? Что еще запомнилось?
Re[3]: Создание справки и документации
От: Matrix_Failure http://matrixfailure.wordpress.com/
Дата: 01.02.18 10:11
Оценка:
Здравствуйте, Submitter, Вы писали:

M_F>>Мы перешли на Dr.Explain


S>Конкурентов смотрели? Что еще запомнилось?

Даже применяли, но там не было автоматической герерации скриншотов. С её помощью очень удобно и быстро(!) обновлять хелп при выпуске новых версий. Нажимаешь "Схватить Экран", тыщь-пыщь и готово. Только добавить текствое описание новых кнопок.
Отредактировано 01.02.2018 10:12 Matrix_Failure . Предыдущая версия .
Re[4]: Создание справки и документации
От: Submitter  
Дата: 01.02.18 10:12
Оценка:
Здравствуйте, Matrix_Failure, Вы писали:

S>>Конкурентов смотрели? Что еще запомнилось?

M_F>Даже применяли, но там не было автоматической герерации скриншотов. С её помощью очень удобно и быстро(!) обновлять хелп при выпуске новых версий. Тыщь-пыщь и готово. Только добавить текствое описание новых кнопок.

Можете в двух словах объяснить что такое "автоматическая генерация скриншотов" и как это работает?
Re[5]: Создание справки и документации
От: Matrix_Failure http://matrixfailure.wordpress.com/
Дата: 01.02.18 10:19
Оценка:
Здравствуйте, Submitter, Вы писали:

S>Можете в двух словах объяснить что такое "автоматическая генерация скриншотов" и как это работает?


Нажимаешь "Добавить раздел с аннотированным экраном" и Dr.Explain сканирует в нашей программе элементы интерфейса, скриншотит их, и создает в хелпе аннотированный экран программы.

Чтобы обновить копии экрана в новой версии нажимаешь правой кнопкой мыши и выбираешь "Заменить захватом".
Отредактировано 01.02.2018 10:20 Matrix_Failure . Предыдущая версия .
Re: Создание справки и документации
От: Dennis Crane Россия Софт для создания хелп-файлов и онлайн справки
Дата: 01.02.18 10:45
Оценка: 20 (5) +1
Здравствуйте, Submitter, Вы писали:

S>Чем вы создаете справку для своих программ (не считая чистого HTML) и какую программу вы бы хотели? Что она должна уметь?


Как человек, который немного в теме , выскажу несколько тезисов о нише в целом:

1) Потребности и нюансы у всех проектов очень разные. Одной тулзой всех тяжело осчастливить. С хелпописалками есть одна серьезная ментальная ловушка разработчика — "что там писать-то? взял готовый компонент редактора, прикрутил дерево разделов, экспорт в несколько форматов ... PROFIT". Мне часто говорят, что наша тулза клонируется за полгода. А дьявол в деталях, на некоторые из которых уходят человеко-месяцы. А в профессиональных инструментах, которыми человек может пользоваться весь рабочий день, детали и мелочи очень важны. Борьба ведется за каждый лишний клик, за каждый, можно сказать, пиксель.

2) Шароварщики — вообще не тот сегмент, на который надо целится. Вот некоторые из последних отечественных клинетов:
* Асфальтобетонный завод
* Стивидорная компания
* Агентство ипотечного кредитования
* Сервис по продаже авиационных и железнодорожных билетов
* Торговый дом
* Застройщик
* Издательство
* Проектное агенство
* Геодезическая компания
* Банк
* Сеть супермаркетов
* Агентство грузоперевозок
* Компания по ремонту и строительству дорог
* Разработчики медицинского оборудования
* Судостроительный завод
* Геологический НИИ
Поэтому с активной рекламой очень сложно. Нет четкого сегмента, в который можно было бы целится с гарантированным ROI. Массовые бомбардировки не проходят, только снайперские тактики.

2) Ниша очень насыщена — океан красен от крови. Цикл продаж очень долгий. Конкурировать придется не только с кучей коммерческих решений во всех ценовых сегментах и их спираченными версиями, но и с кучей бесплатных — вики, гугл докс, опенофис и т.д. И при этом, что очень важно, конкурировать также придется и с распространненным взглядом "хелп никому особо не нужен. сляпаем что-нибудь в ворде на десять страничек". Т.е. сначала нужно просто убедить клиента, что ему нужне хелп, а потом еще убедить, что этот хелп нужно писать именно вашей тулзой.
Сейчас, я не уверен, что полез бы сюда, зная как тут все. С 2005 года ландшафт сильно поменялся.
- — —
Dr.Explain: программа для создания хелп-файлов и онлайн справок
Re[3]: Создание справки и документации
От: rean  
Дата: 01.02.18 13:19
Оценка: 4 (1)
deleted
Отредактировано 22.04.2019 9:25 deleted2 . Предыдущая версия .
Подождите ...
Wait...
Пока на собственное сообщение не было ответов, его можно удалить.