Мы планируем в базе знаний делать хелп-инструкцию по каждому модулю. и в каждом модуле сделать стандарт хелпа (потому что пока у всех по разному)
Никита сейчас по общим интерфейсам системы пишет, а я переношу все полезное/актуальное в базу
удобно будет в базе знаний написать хелп? аккаунт в админке сделаю
Интересно было бы увидеть типовой вариант оформления хелпа в модулях. Особенно интересно, как будет стыковаться мультиязычность и большие тексты в хелпе, т.к. текущий механизм перевода интерфейса системы и модулей, как мне кажется, не совсем подходит для организации больших текстов.
По части базы знаний - считаю, что статьи в ней должны носить другой характер в сравнении со справкой внутри модулей, - более подробные, с пошаговыми инструкциями и кучей скриншотов. )) Хелп в модуле такого формата будет избыточен, по идее там достаточно кратких справочных сведений.
По типовому варианту - как раз у нас с Сергеем стоит таск обсудить типовой вариант.
Лично мне пока нравится вариант простой ссылки на папку в базу знаний, которая объдиняет инфо по конкретному модулю, например: http://joxi.ru/krDGp7XT0j8WbA
Так, в принципе, построен хелп почти у всего софта
Это же решит и вопрос больших текстов
Мультиязычность - шаблон базы занний который ставился предполагает мультиязычность в платной версии. Это была одна из причин почти выбран был именно этот шаблон
ПО характеру статей - полностью согласен с пошаговыми инструкциями и скриншотами
так и планиурется
+идея собрать в принципе всю полезную инфу в одном месте, например, в папке модуля ХХХ.
Чтобы не было что кусок ифны в самом модуле, кусок на форуме, кусок в базе знаний и т.д.
Как вариант, использовать имеющийся механизм помощи через открывающийся popup с wiki-страницей. Это уже встроено и используется в нескольких модулях, оно нормально дружит с мультиязычностью (для русского и английского разные ссылки), в самой wiki можно ставить картинки, ссылки на связанные страницы и т.п. Ну и заполнять может не только автор модуля, но и любой участник проекта. База знаний как единая точка входа может быть и хорошо, но тоже не хотелось бы из неё делать "свалку" :)
эээ, а каким образом добавление хелп-инфо в базу знаний (которая и предполагает в себе полезную инфо о тот КАК работает система и ее модули) превратит базу знаний в "свалку"?))
Ок, согласен :) толковая база знаний с инфой по всем модулям будет лучше. У Вики есть свои плюсы, но там сложно ориентироваться. Давайте попробуем сделать красивую структуру хэлпов в базе знаний.
Пожалуйста, войдите в систему, чтобы добавлять комментарии Присоединиться!