Документация для Джустины.
  • GoDrGoDr Октябрь 2011
    Какие предложения есть по этому вопросы?
    Что интересует:
    1. Как организовать структуру документации
    2. Какой механизм использовать (например, вики, босс настроить и т.п.)
  • abasiaabasia Октябрь 2011
    В теме: Приоритеты при разработке новой версии Joostina 1.3 отписал
    Считаю надо всё собрать в одном месте, что бы база знаний копилась, имела контроль и не расползалась на сто ручейков. В том же Redmine можно внутренний форум и чат прицепить, тяжело просто искать по темам, а если она не активна долго то вообще теряется.
    Отредактированно abasia в 2011-10-16 03:46:28
  • GoDrGoDr Октябрь 2011
    на вопрос ты так и не ответил :) где хранить, разберёмся.. сначала нужно определиться как
  • abasiaabasia Октябрь 2011
    Как по мне, так WIKI удобно
  • GoDrGoDr Октябрь 2011
    а ты с ней общался? Просто ужас... В ней можно только искать то что уже знаешь, да и заполнение ужасное.. Хотя сама идея нормальная.. Я вот думаю на Босс.. может его настроить как-то.. Я вообще думаю сделать типа три документации

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

    2. Вопрос-Ответ

    3. Чистый справочник, т.е.
    - Файл.php
    --- Функция 1
    --- Функция 2
    --- Класс1
    ------ свойство 1
    ------ свойство 2
    ------ метод 1
    ------ метод 2
  • abasiaabasia Октябрь 2011
    Тут опыта у меня никакого нет, я лишь могу идею предложить, если возможно на Боссе всё организовать так вообще хорошо, будет всё на своём :)
  • ArkadiyArkadiy Октябрь 2011
    Такое на Боссе делается на раз, и навигация, фильтрация, поиск может быть удобно настроены, на вики получим сумбур в котором будет трудно разобраться. Участвую в переделке joomlaportal, они за основу взяли CCK flexicontent, именно из таких-же соображений.
  • abasiaabasia Октябрь 2011
    Давайте на этом и порешим, будем развивать на Боссе, заодно и Босс будет под потребности развиваться, тогда в соседней теме этот вопрос надо закрыть чтоб не дублировать.
  • GoDrGoDr Октябрь 2011
    Тогда Аркадий к тебе вопрос.. В системе нужно организовать пересылочную систему. Т.е. если в статье встречается название функции/класса, то это ссылка вела бы на соответствующий материал
  • ArkadiyArkadiy Октябрь 2011
    Автоматически? Как я должен отличить название ссылки/класса от остального текста? Есть алгоритм?
  • GoDrGoDr Октябрь 2011
    хотя всё равно не могу как организовать структуру
    пример, категория (название класса database), в ней статьи (_instance, _sql ... getInstance, getErrorNum)
    Отредактированно GoDr в 2011-10-16 04:41:40
  • GoDrGoDr Октябрь 2011
    алгоритм получится простой, проверить статьи на наличие одноимённых статей.. Типа анализатора.. Можно иногда запускать, чтобы он анализировал сожержимое и если совпадало название статьи и слова в тексте, делал бы ссылку
  • abasiaabasia Октябрь 2011
    >Участвую в переделке joomlaportal
    Это не повлияет на ветку Джустины на их форуме, там много полезного обсуждалось, жалко если грохнут её под корень.
  • ArkadiyArkadiy Октябрь 2011
    Не,они переделывают только портал, форум пока не трогают.
  • ArkadiyArkadiy Октябрь 2011
    > хотя всё равно не могу как организовать структуру
    пример, категория (название класса database), в ней статьи (_instance, _sql ... getInstance, getErrorNum)

    Категории должны быть человекопонятны, а вот дополнительные поля можно сделать любыми, например название класса, название метода и т.п.
    Отредактированно Arkadiy в 2011-10-16 06:23:34
  • GoDrGoDr Октябрь 2011
    человеческие это вместо _instance будет "свойство _instance класса database" так?
  • ArkadiyArkadiy Октябрь 2011
    Да, примерно так
    Отредактированно Arkadiy в 2011-10-16 06:26:03
  • GoDrGoDr Январь 2012
    В каком формате создавать справочник? В чистом PDF или что-то интерактивное нужно?
    Первое проще и быстрее :)
  • abasiaabasia Январь 2012
    Хватит и pdf, потом всегда переделать можно, когда есть что делать.
    Спасибо GoDr за труды.
  • GoDrGoDr Январь 2012
    В общем как я и не старался объять необъятное, пришёл в выводу что нужно ставить вики-движок.. Делать всё одним файлом очень и очень сложно ... получается громоздко. Это всё равно что книгу написать :)

    Так что тестирую разные вики-движки и уже на них всё делать буду

    @abasia, скорее всего субдомен нужно сделать типа http://wiki.joostinadev.ru/
    Отредактированно GoDr в 2012-01-28 06:52:06
  • abasiaabasia Январь 2012
    Сделаю или если правильней сам сделай, данные доступа в личку скинул.
  • GoDrGoDr Январь 2012
    ок...
    Убил весь день и всё таки решил остановиться на MediaWiki

Добро пожаловать!

Похоже, что Вы здесь впервые. Если хотите поучаствовать, нажмите на одну из этих кнопок!

Войти Зарегистрироваться

В теме отметились