CRM Руководитель - Форум

Коллеги, планирую создать документацию по проекту. Изначально хотел использовать https://www.mediawiki.org
Но может есть более специализированные проекты для этого?

HelpNDoc как вариант... Единственное пожалуй решение, где не нужно ломать голову над всякими "посторонними" вопросами (html-теги, маркдаун и т.п.).
Работаешь с ним как с MsWord, на выходе мультиформатная справка в т.ч. html с готовым поиском на js.

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

А если ещё и встроенный движок запилить, тогда вообще 2 зайца можно грохнуть...

dokuwiki не плохой движок и синтаксис понятный

Oleg писал(а): ↑22 апр 2019, 10:14 синтаксис понятный

Также к докувики и медиавики можно прикрутить tinymce для удобства.

HelpNDoc - неплохой вариант, но для не владеющих иностранными языками будет возможно не очень комфортно... Хотя, смотря кто будет работать по составлению документации .

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

Но и инструкции должны конечно не только содержать максимум информации, но и быть структурированными и последовательными, с наиболее понятным (для простого пользователя) описанием работы и функционала. Важны будут также "перелинковки" (взаимосвязи) со смежными/сопутствующими разделами справки, видеоконтент и т.п.

Я уже имел дело с созданием справочных систем по работе с веб-приложениями, админками, так что могу сказать, что работа нелегкая, требующая времени, но однозначно нужная, значительно повысит лояльность как текущих, так и будущих клиентов/пользователей системы Руководитель.

так что могу сказать, что работа нелегкая, требующая времени

Это точно, мне проще кусок кода написать, чем выписывать все эти тексты:)
Но сделать надо. Раз у вас есть опыт, буду у вас советоваться, можно?:)

Но сделать надо. Раз у вас есть опыт, буду у вас советоваться, можно?:)

Конечно, без проблем

https://readthedocs.org

если бы что-то в таком виде было, то, вроде просто и понятно для пользователя, пример документации: https://peewee.readthedocs.io/en/latest/index.html

еще такую штуку нашел https://www.phpdoc.org/, но это, наверное уже как расширенное дополнение для разработчиков, которые используют исходный код для создания систем на основе Руководителя. Не знаю, насколько этот ресурс вообще будет полезен...

alcompstudio писал(а): ↑22 апр 2019, 17:03 https://readthedocs.org

"Вечный онлайн", если не ошибаюсь...

alcompstudio писал(а): ↑22 апр 2019, 15:48...для не владеющих иностранными языками будет возможно не очень комфортно...

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

alcompstudio писал(а): ↑22 апр 2019, 15:48 Но и инструкции должны конечно не только содержать максимум информации, но и быть структурированными и последовательными, с наиболее понятным (для простого пользователя) описанием работы и функционала. Важны будут также "перелинковки" (взаимосвязи) со смежными/сопутствующими разделами справки, видеоконтент и т.п.

Ну все верно - речь о helpNdoc ...

Еще как вариант - WordPress с плагином типа documentor. Аналогичных для WP есть еще несколько, но не помню точно название (можно посмотреть в установщике плагинов WP по запросу "documentation").

А можно ли сделать так, чтобы документацию для Руководителя можно было создавать в самом Руководителе?
Вроде бы для этого в системе все есть.