Документация
- support
- Техническая поддержка
- Сообщения: 9190
- Зарегистрирован: 19 окт 2014, 18:22
- Имя: Харчишин Сергей
- Откуда: Крым, Евпатория
Документация
Коллеги, планирую создать документацию по проекту. Изначально хотел использовать https://www.mediawiki.org
Но может есть более специализированные проекты для этого?
Но может есть более специализированные проекты для этого?
- Develop-Soft
- Сообщения: 690
- Зарегистрирован: 27 мар 2019, 01:22
- Имя: Владимир
- Откуда: Россия, Белгород
- Контактная информация:
Re: Документация
HelpNDoc как вариант... Единственное пожалуй решение, где не нужно ломать голову над всякими "посторонними" вопросами (html-теги, маркдаун и т.п.).
Работаешь с ним как с MsWord, на выходе мультиформатная справка в т.ч. html с готовым поиском на js.
Оффтоп: однажды целенаправленно и долго искал решение - все как-то не очень подходило (наверное у меня завышенные требования к подобному движку ) либо денег отвали. Платить денег за справку к бесплатному приложению не стал из принципа.
А если ещё и встроенный движок запилить, тогда вообще 2 зайца можно грохнуть...
Работаешь с ним как с MsWord, на выходе мультиформатная справка в т.ч. html с готовым поиском на js.
Оффтоп: однажды целенаправленно и долго искал решение - все как-то не очень подходило (наверное у меня завышенные требования к подобному движку ) либо денег отвали. Платить денег за справку к бесплатному приложению не стал из принципа.
А если ещё и встроенный движок запилить, тогда вообще 2 зайца можно грохнуть...
Последний раз редактировалось Develop-Soft 22 апр 2019, 10:15, всего редактировалось 1 раз.
- Oleg
- Сообщения: 471
- Зарегистрирован: 26 окт 2018, 08:23
- Имя: Олег Родионов
- Откуда: Россия,Санкт-Петербург
Re: Документация
dokuwiki не плохой движок и синтаксис понятный
Установка и настройка IP ATC Asterisk
- Develop-Soft
- Сообщения: 690
- Зарегистрирован: 27 мар 2019, 01:22
- Имя: Владимир
- Откуда: Россия, Белгород
- Контактная информация:
Re: Документация
Также к докувики и медиавики можно прикрутить tinymce для удобства.
- alcompstudio
- Спонсор
- Сообщения: 1739
- Зарегистрирован: 03 янв 2016, 20:42
- Имя: Александр
- Откуда: Мир
Re: Документация
HelpNDoc - неплохой вариант, но для не владеющих иностранными языками будет возможно не очень комфортно... Хотя, смотря кто будет работать по составлению документации .
Вообще составление инструкции, мануала для Руководителя - очень важный момент, особенно в настоящее время, т.к. функционал уже достаточно широк и для новых/неосведомленных пользователей, конечно, затруднительно собрать подходящую информацию.
Но и инструкции должны конечно не только содержать максимум информации, но и быть структурированными и последовательными, с наиболее понятным (для простого пользователя) описанием работы и функционала. Важны будут также "перелинковки" (взаимосвязи) со смежными/сопутствующими разделами справки, видеоконтент и т.п.
Я уже имел дело с созданием справочных систем по работе с веб-приложениями, админками, так что могу сказать, что работа нелегкая, требующая времени, но однозначно нужная, значительно повысит лояльность как текущих, так и будущих клиентов/пользователей системы Руководитель.
Вообще составление инструкции, мануала для Руководителя - очень важный момент, особенно в настоящее время, т.к. функционал уже достаточно широк и для новых/неосведомленных пользователей, конечно, затруднительно собрать подходящую информацию.
Но и инструкции должны конечно не только содержать максимум информации, но и быть структурированными и последовательными, с наиболее понятным (для простого пользователя) описанием работы и функционала. Важны будут также "перелинковки" (взаимосвязи) со смежными/сопутствующими разделами справки, видеоконтент и т.п.
Я уже имел дело с созданием справочных систем по работе с веб-приложениями, админками, так что могу сказать, что работа нелегкая, требующая времени, но однозначно нужная, значительно повысит лояльность как текущих, так и будущих клиентов/пользователей системы Руководитель.
- support
- Техническая поддержка
- Сообщения: 9190
- Зарегистрирован: 19 окт 2014, 18:22
- Имя: Харчишин Сергей
- Откуда: Крым, Евпатория
Re: Документация
Это точно, мне проще кусок кода написать, чем выписывать все эти тексты:)так что могу сказать, что работа нелегкая, требующая времени
Но сделать надо. Раз у вас есть опыт, буду у вас советоваться, можно?:)
- alcompstudio
- Спонсор
- Сообщения: 1739
- Зарегистрирован: 03 янв 2016, 20:42
- Имя: Александр
- Откуда: Мир
Re: Документация
Конечно, без проблемНо сделать надо. Раз у вас есть опыт, буду у вас советоваться, можно?:)
- alcompstudio
- Спонсор
- Сообщения: 1739
- Зарегистрирован: 03 янв 2016, 20:42
- Имя: Александр
- Откуда: Мир
Re: Документация
https://readthedocs.org
если бы что-то в таком виде было, то, вроде просто и понятно для пользователя, пример документации: https://peewee.readthedocs.io/en/latest/index.html
еще такую штуку нашел https://www.phpdoc.org/, но это, наверное уже как расширенное дополнение для разработчиков, которые используют исходный код для создания систем на основе Руководителя. Не знаю, насколько этот ресурс вообще будет полезен...
если бы что-то в таком виде было, то, вроде просто и понятно для пользователя, пример документации: https://peewee.readthedocs.io/en/latest/index.html
еще такую штуку нашел https://www.phpdoc.org/, но это, наверное уже как расширенное дополнение для разработчиков, которые используют исходный код для создания систем на основе Руководителя. Не знаю, насколько этот ресурс вообще будет полезен...
- Develop-Soft
- Сообщения: 690
- Зарегистрирован: 27 мар 2019, 01:22
- Имя: Владимир
- Откуда: Россия, Белгород
- Контактная информация:
Re: Документация
"Вечный онлайн", если не ошибаюсь...
Мне кажется, что язык интерфейса это наверное самое последнее на что стоит смотреть при выборе инструмента для создания справки. Главное - функционал. А перевод можно и свой сделать при необходимости...alcompstudio писал(а): ↑22 апр 2019, 15:48...для не владеющих иностранными языками будет возможно не очень комфортно...
Ну все верно - речь о helpNdoc ...alcompstudio писал(а): ↑22 апр 2019, 15:48 Но и инструкции должны конечно не только содержать максимум информации, но и быть структурированными и последовательными, с наиболее понятным (для простого пользователя) описанием работы и функционала. Важны будут также "перелинковки" (взаимосвязи) со смежными/сопутствующими разделами справки, видеоконтент и т.п.
Еще как вариант - WordPress с плагином типа documentor. Аналогичных для WP есть еще несколько, но не помню точно название (можно посмотреть в установщике плагинов WP по запросу "documentation").
- Евгений
- Сообщения: 461
- Зарегистрирован: 11 июл 2016, 13:21
- Имя: Евгений
- Откуда: Петропавловск-Камчатский
Re: Документация
А можно ли сделать так, чтобы документацию для Руководителя можно было создавать в самом Руководителе?
Вроде бы для этого в системе все есть.
Вроде бы для этого в системе все есть.