Какие предложения есть по этому вопросы? Что интересует: 1. Как организовать структуру документации 2. Какой механизм использовать (например, вики, босс настроить и т.п.)
В теме: Приоритеты при разработке новой версии Joostina 1.3 отписал Считаю надо всё собрать в одном месте, что бы база знаний копилась, имела контроль и не расползалась на сто ручейков. В том же Redmine можно внутренний форум и чат прицепить, тяжело просто искать по темам, а если она не активна долго то вообще теряется.
а ты с ней общался? Просто ужас... В ней можно только искать то что уже знаешь, да и заполнение ужасное.. Хотя сама идея нормальная.. Я вот думаю на Босс.. может его настроить как-то.. Я вообще думаю сделать типа три документации
1. Для пользователей - описать механизм установки, настройки, т.е. какой пункт меню или кнопка и для чего нужны.
2. Вопрос-Ответ
3. Чистый справочник, т.е. - Файл.php --- Функция 1 --- Функция 2 --- Класс1 ------ свойство 1 ------ свойство 2 ------ метод 1 ------ метод 2
Такое на Боссе делается на раз, и навигация, фильтрация, поиск может быть удобно настроены, на вики получим сумбур в котором будет трудно разобраться. Участвую в переделке joomlaportal, они за основу взяли CCK flexicontent, именно из таких-же соображений.
Давайте на этом и порешим, будем развивать на Боссе, заодно и Босс будет под потребности развиваться, тогда в соседней теме этот вопрос надо закрыть чтоб не дублировать.
Тогда Аркадий к тебе вопрос.. В системе нужно организовать пересылочную систему. Т.е. если в статье встречается название функции/класса, то это ссылка вела бы на соответствующий материал
хотя всё равно не могу как организовать структуру пример, категория (название класса database), в ней статьи (_instance, _sql ... getInstance, getErrorNum)
алгоритм получится простой, проверить статьи на наличие одноимённых статей.. Типа анализатора.. Можно иногда запускать, чтобы он анализировал сожержимое и если совпадало название статьи и слова в тексте, делал бы ссылку
> хотя всё равно не могу как организовать структуру пример, категория (название класса database), в ней статьи (_instance, _sql ... getInstance, getErrorNum)
Категории должны быть человекопонятны, а вот дополнительные поля можно сделать любыми, например название класса, название метода и т.п.
В общем как я и не старался объять необъятное, пришёл в выводу что нужно ставить вики-движок.. Делать всё одним файлом очень и очень сложно ... получается громоздко. Это всё равно что книгу написать :)
Так что тестирую разные вики-движки и уже на них всё делать буду