Re: Создание справки и документации
От: Dennis Crane Россия Софт для создания хелп-файлов и онлайн справки
Дата: 01.02.18 10:45
Оценка: 20 (5) +1
Здравствуйте, Submitter, Вы писали:

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


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

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

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

2) Ниша очень насыщена — океан красен от крови. Цикл продаж очень долгий. Конкурировать придется не только с кучей коммерческих решений во всех ценовых сегментах и их спираченными версиями, но и с кучей бесплатных — вики, гугл докс, опенофис и т.д. И при этом, что очень важно, конкурировать также придется и с распространненным взглядом "хелп никому особо не нужен. сляпаем что-нибудь в ворде на десять страничек". Т.е. сначала нужно просто убедить клиента, что ему нужне хелп, а потом еще убедить, что этот хелп нужно писать именно вашей тулзой.
Сейчас, я не уверен, что полез бы сюда, зная как тут все. С 2005 года ландшафт сильно поменялся.
- — —
Dr.Explain: программа для создания хелп-файлов и онлайн справок
Re: Создание справки и документации
От: ov  
Дата: 01.02.18 22:54
Оценка: 17 (4)
S>Какой вы видите программу, создающую справку к чему-либо или документацию?
S>Чем вы создаете справку для своих программ (не считая чистого HTML) и какую программу вы бы хотели? Что она должна уметь?

как тебе Денис правильно намекнул, вычеркни вторую половину своего вопроса и оставь только первую: "как вы видите программу для создания документации?"

поясню: сейчас появился огромный пласт приложений вообще без документации: веб-приложения и мобайл. справки там в 99% тупо нет вообще. есть подсказки, ролики, встроенные обучалки итп. новое поколение, обучившееся на таких программах, будет ожидать чего-то подобного и от обычного софта. поэтому правильная справка для софта это туториалы + faq, большего зачастую не требуется.

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

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

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

напоследок история: жила была одна компания, которая занималась CAD-ом и смежными 3D-темами. и выпустила она софт, который позволял "разобрать/собрать" 3д-модельку, заснять процесс в виде серии кадров, нарисовать это в стиле схематических чертежей и добавить к каждому шагу описания. получился такой генератор инструкций по сборке/разборке всяких механизмов. и пришла эта компания к крупному авиа-производителю, мол вот у нас что есть. те посмотрели, оценили, но отказались покупать. причина была такова: у них подобные инструкции составлял отдел из порядка тысячи человек. если бы они купили эту программу, их почти всех пришлось бы уволить, что создало бы им массу проблем другого рода.

вобщем, документация это сложная тема
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]: Создание справки и документации
От: rean  
Дата: 01.02.18 13:19
Оценка: 4 (1)
deleted
Отредактировано 22.04.2019 9:25 deleted2 . Предыдущая версия .
Re[3]: Создание справки и документации
От: kov_serg Россия  
Дата: 01.02.18 22:33
Оценка: 4 (1)
Здравствуйте, Lazytech, Вы писали:

L>Здравствуйте, kov_serg, Вы писали:


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

pdf как формат для печати, а не для поиска. epub для электорнных читалок. есть еще dvi и ps но не уверен что они так широко используются.
Проблема поиска решается нормальным оглавлением и предметным указателем. Поиск там не так важен.
Идея в том что бы документ можно было издать как на десктопе, так на электронных книгах, телефонах, а так же распечатать как книгу, брошуру или инструкцию или еще лучше подготовить к изданию в типографии.

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

Дык для десктопа самый кошерный формат chm (но он только с одной кодовой страницой работает, хотя это не есть серьёзное ограничение для html которые умеет кодировать символы вне кодовой страницы).
L>P.P.S. Кстати, поиск по документу PDF иногда не находит даже те словосочетания, которые в нем точно есть, из-за жесткого переноса на следующую строку.
Это уже притензии к адобу ему виделте ли досих пор трудно лигатуры (типа fl fi...) в буквы преобразовать. хотя бывают и патлогические случаии сканированных страниц в pdf и кастомных шрифтов. Хотя даже обычный xpdf спокойно может вынимать вменяемый текст для индексации, в то время как адоб вынимает реликтовое излучение.
Re[2]: Создание справки и документации
От: marcopolo Россия  
Дата: 02.02.18 02:35
Оценка: 4 (1)
Здравствуйте, kov_serg, Вы писали:


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

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

Оно у Win10 уже не работает само, нужно пак ставить.
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[2]: Создание справки и документации
От: Submitter  
Дата: 01.02.18 05:09
Оценка: +1
Здравствуйте, Lazytech, Вы писали:

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


DrExplain? Все руки не дойдут скачать и посмотреть.
Re[3]: Создание справки и документации
От: Qt-Coder  
Дата: 01.02.18 07:50
Оценка: +1
Здравствуйте, Submitter, Вы писали:

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

Типичная ошибка — начинать разработку не изучив конкурентов.
Re[2]: Создание справки и документации
От: Aquilaware  
Дата: 02.02.18 15:35
Оценка: +1
Здравствуйте, rean, Вы писали:

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


Вэб это только один из каналов распространения помощи.

По-хорошему, кардинальность справки и продукта должна совпадать: если продукт может работать без поключения к интернету, то и справка должна работать без него.
Создание справки и документации
От: Submitter  
Дата: 01.02.18 04:39
Оценка:
Какой вы видите программу, создающую справку к чему-либо или документацию?
Чем вы создаете справку для своих программ (не считая чистого HTML) и какую программу вы бы хотели? Что она должна уметь?
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: Создание справки и документации
От: kov_serg Россия  
Дата: 01.02.18 05:12
Оценка:
Здравствуйте, Submitter, Вы писали:

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

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

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

Должна быть копактной, не требовательной, без зависимостей и работать от xp до linux
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[2]: Создание справки и документации
От: Submitter  
Дата: 01.02.18 13:51
Оценка:
Здравствуйте, Dennis Crane, Вы писали:

Благодарю за развернутый ответ. Еще вопрос: вижу, что на сайте компании у вас всего 2 программы. Неужели только на них двух "кормитесь"?

Еще вопрос немного на другую тему: собрался уходить от GoDaddy, а вы не думаете сделать то же самое? Говорят GoDaddy блокирует домены по разных причинам, но боитесь, что это произойдет с вами? Я собираюсь уходить и решаю к кому из этих трех: NameCheap, Domain, Name (сайты одноименные).
Re[3]: Создание справки и документации
От: Dennis Crane Россия Софт для создания хелп-файлов и онлайн справки
Дата: 01.02.18 15:02
Оценка:
Здравствуйте, Submitter, Вы писали:

S>Здравствуйте, Dennis Crane, Вы писали:


S>Благодарю за развернутый ответ. Еще вопрос: вижу, что на сайте компании у вас всего 2 программы. Неужели только на них двух "кормитесь"?

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

S>Еще вопрос немного на другую тему: собрался уходить от GoDaddy, а вы не думаете сделать то же самое? Говорят GoDaddy блокирует домены по разных причинам, но боитесь, что это произойдет с вами? Я собираюсь уходить и решаю к кому из этих трех: NameCheap, Domain, Name (сайты одноименные).

Нет четкого ответа. Где гарантия, что NameCheap не сделает то же самое, если на него кто-нибудь нажмет?
В нынешнем мире не знаешь, откуда прилетит черный лебедь. Гуляй-поле в интернет-бизнесе образца начала 2000-х закончилось. Регуляторы зажимают со всех сторон, внимание к IT и е-бизнесу все пристальнее, т.к. это стало реальным сектором экономики и социально-политическим инструментом. Кто-то крупный (государства, корпорации, спецслужбы) постоянно хочет свои интересы продвинуть, а мелочь огребает из-за этого.
- — —
Dr.Explain: программа для создания хелп-файлов и онлайн справок
Re[3]: Создание справки и документации
От: kov_serg Россия  
Дата: 01.02.18 22:29
Оценка:
Здравствуйте, Submitter, Вы писали:

S>Здравствуйте, kov_serg, Вы писали:


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

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

S>Это же очень сильно устарело. Помню лет 10-12 был Microsoft Work Shop (или как-то так), но это же очень устарело?

Microsoft Work Shop идёт лесом. это убожество использовать не возможно.
В то время как сам компилятор hhc после небольшого патча работает как часы.
Re[2]: Создание справки и документации
От: Qt-Coder  
Дата: 02.02.18 04:11
Оценка:
Кстати да, на заводах есть нормоконтролер, который отслеживает правильность документации, придираясь к отступам и шрифтам. Руководствуется он при этом книжечкой по ГОСТу. А работники пишут документацию в ворде, который ничего про это не знает. Можно написать макрос для ворда, который будет проверять документацию до похода к нормоконтролеру.
Re[3]: Создание справки и документации
От: Dennis Crane Россия Софт для создания хелп-файлов и онлайн справки
Дата: 02.02.18 06:29
Оценка:
Здравствуйте, Qt-Coder, Вы писали:

QC>Кстати да, на заводах есть нормоконтролер, который отслеживает правильность документации, придираясь к отступам и шрифтам. Руководствуется он при этом книжечкой по ГОСТу. А работники пишут документацию в ворде, который ничего про это не знает. Можно написать макрос для ворда, который будет проверять документацию до похода к нормоконтролеру.


Ну и что-бы закольцевать тему. В ГОСТах мы уже тоже поковырялись
Разработка руководства пользователя по ГОСТ 34 и ГОСТ 19 в программе Dr.Explain
- — —
Dr.Explain: программа для создания хелп-файлов и онлайн справок
Отредактировано 02.02.2018 6:31 Dennis Crane . Предыдущая версия .
Re[3]: Создание справки и документации
От: kov_serg Россия  
Дата: 02.02.18 16:07
Оценка:
Здравствуйте, marcopolo, Вы писали:

M>Здравствуйте, kov_serg, Вы писали:



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

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

M>Оно у Win10 уже не работает само, нужно пак ставить.

Достаточно к себе затянуть
hh.exe 10kb
msvcrt.dll 343kb

и о чудо работает невзирая на windows
и вообше полный комплект для chm в винде весит 1.4Мб. Он компилирует, декомпилирует и отображает chm.
Re[2]: Создание справки и документации
От: kov_serg Россия  
Дата: 02.02.18 16:19
Оценка:
Здравствуйте, rean, Вы писали:

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


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

Вы видели как печатает браузер? Без слёз не взглянешь.
браузер это такой god-object, всё может всё умеет, но постоянно требует всё больше и больше ресурсов
Re[4]: Создание справки и документации
От: salnicoff  
Дата: 03.02.18 08:37
Оценка:
Здравствуйте, kov_serg, Вы писали:

M>>Оно у Win10 уже не работает само, нужно пак ставить.

_>Достаточно к себе затянуть
_>hh.exe 10kb
_>msvcrt.dll 343kb

_>и о чудо работает невзирая на windows

А насколько это законно? MS официально разрешает таскать с собой эти файлы?
 
Подождите ...
Wait...
Пока на собственное сообщение не было ответов, его можно удалить.