Вход • Регистрация

Документация для разработчиков

  •
  • 15 октября 2012 г. , редакция: 09 ноября 2013 г.
  • Друзья!
    У нас новый сотрудник, технический писатель! Который будет заниматься только документацией, ее обновлением и поддержанием. Если есть какие-то пожелания, вопросы, требования или жалобы, пишите здесь.
    • 09 ноября 2013 г.
    • 1. Отметить версию цмс для которой актуально описание функционала.
      2. вывод кода продублировать скрином, как выглядит в натуре
      3. новые внедрения, тоже как-то бы выделить
      • 11 ноября 2013 г.
      • Цитата
        Дима (agatahttp)
        1. Отметить версию цмс для которой актуально описание функционала.
        2. вывод кода продублировать скрином, как выглядит в натуре
        3. новые внедрения, тоже как-то бы выделить


        1,3 засрёт документацию ужасно представьте себе просто что в итоге получится, при увеличении кол-ва версий диафана, например 10 версий диафана, 10 нововведений, 10 различных вариантов решения, ну и всё разноцветно. ))))
        2 бррррррррр, изврат. 10 версий = варианты различные, разноцветность += 100500 картинок кода, да и зачем тут эти картинки не понятно, блокнот что-ли не видели.

        --------------------
        хотя, а смысл дублировать пожелание если вам уже ответили, что предложение ужасно.
        ---
        надо как-то так:
        1. Сделать версионность = типа выбираем из списка вариант cms, появляется соответствующая документация.
        2. Раздел для новичков, аля вода про MVC.
        3. Описать технические возможности, скрытые, например как сделать ajax корзину.
        4. Постить, запросы/ответы в тех.поддержку, решающую ту или иную проблему. Тут или на форум, или в некий особый раздел.
        5. Более подробное описание нововведений, или хотя бы просто их описания. Понятное дело, что кто следит за пожеланиями итак их все знает, но всё же удобней сразу видеть, что было добавлено.

        По приоритету, я бы расставил так:
        4,3,5,2,1
      •
      • 11 ноября 2013 г.
      • Хочу немного дополнить по первому пункту (с остальными двумя не согласен - лишнее это):
        Версию каждой CMS указывать не нужно, но нужно указывать с какой версии это актуально (в этой теме писал почему). Для примера документацию PHP посмотреть - работает с такой-то версии, в такой-то версии исключено или изменено.

        И от себя добавить:
        Нужна оффлайн-справка (точная копия той, что на сайте). Сайт периодически недоступен бывает, т.к. дата-центр у вас не в соседнем доме расположен. У меня сайты на bluhost лежат в Юте(США), аптайм 100% практически, а в Москве они периодически не доступны из-за плохого коннекта.

        Регулярно (особенно после изменений и дополнений страниц) прогонять online-справку через валидатор ссылок, чтобы своевременно находить битые ссылки.
        •
        • 11 ноября 2013 г.
        • Цитата
          Для примера документацию PHP посмотреть - работает с такой-то версии, в такой-то версии исключено или изменено.

          Может и правда удобнее самим ребятам будет так как предлагает Илья
          Цитата
          1. Сделать версионность = типа выбираем из списка вариант cms, появляется соответствующая документация.

          пусть даже документация будет повторяться - за то в новую версию не поставят к модулю или функции старое описание, если требуется новое - написать "описание данной функции в разработке, выпуск планируется..., по возникшим вопросам обращайтесь в ТП" - ну что-то подобное.
  •
  • 27 февраля 2013 г.
  • Виталий подскажите, будет ли выделятся в документации новый функционал? Теги, примеры? Просто давно присматриваюсь к цмс. Стараюсь изучать документацию. Но замечаю, если что новое появляется, сразу трудно заметить. Допустим тег show_block module="xxx" выделен красным, доступен в версии 5.2 от 23.04.13
    • 28 февраля 2013 г.
    • А зачем? Вот представьте, приходит новый пользователь, открывает документацию, а там новогодняя елка: красным "доступно в версии 5.2 от 23.04.13", зеленым "доступно в версии 5.1 от 14.06.12", синим "доступно в версии 5.0 от 12.12.11" - нафига ему все это надо?
      Да и старому пользователю должно быть все равно, что когда было добавлено, главное чтобы была актуальная версия доступна.
      Вы за что переживаете? Что функционал новый выйдет, а вы о нем не узнаете?
      • 11 ноября 2013 г.
      • Неверно, наверно
        Для нового пользователя должна быть доступна документация актуальной версии. Но в этой документации хорошо бы видеть ссылки на изменения произошедшие с описываемым.
        Не всегда есть возможность сразу обновить на текущую версию, а по ссылке сразу будет ясно, что у клиента не работает правильно, или, что сделанная пользователем кастомизация так же нуждается в обновлении, или, ... Ну много где пригодится.
        • 26 декабря 2013 г.
        • А леще неплохо было бы изменить лог в личном кабинете Партнера, чтобы было понятно от версии к версии, что именно изменилось. А то он идет одним списком и найти исправлено ли было что-то в следующей версии очень трудно. И нельзя никак отфильтровать ((
  •
  • 11 ноября 2013 г.
  • Видео разбить на отдельные кусочки. Меню, шаблон, модули и т.д.. Если что-то добили новое, например новые теги - легко переснять отдельный кусок. Принадлежность к версии указать.
  • 16 июля 2018 г.
  • Здравствуйте, всем
    Примеры хорошо оформленной документации (!НЕ РЕКЛАМА!):
    https://netcat.ru/developers/docs/#all
    https://readyscript.ru/dev-manual/
    •
    • 16 июля 2018 г.
    • Ну я бы так не сказал что у UMI хорошая документация. Много много вопросов упорядоченых, да. Это не передаёт идейность фундаментальных законов, это больше похоже на тьютеры как сделать то то. Шаг в лево, шаг вправо = расстрел.
      •
      • 16 июля 2018 г.
      • umi?)
        •
        • 16 июля 2018 г. , редакция: 16 июля 2018 г.
        • UMI да так и написал.
          Цитата

          Что такое инфоблок?
          Как настроить файл конфигурации?
          Как зарегистрировать нового пользователя?


          Что это? Это ровно наша база знаний. Это не документация
    •
    • 16 июля 2018 г.
    • Правильнее написать не
      Цитата
      Примеры хорошо оформленной документации
      а "мне нравится как документация оформлена у ....". Потому что мне, например, не нравится ни то ни другое.

Новости

  • Вышла очередная сборка DIAFAN.CMS 7.2.2
  • 18 июня
  • В сборке большое обновление demo-шаблона, дополнительная защита от спама, улучшение YML-импорта и еще много важного и интересного.
  • Не пропустите сборку DIAFAN.CMS 7.1.4
  • 24 апреля
  • В новой сборке совершили революцию в структурировании кастомизированной информации в шаблонах, добавили авторегистрацию пользователей, усовершенствовали защиту от спама, актуализировали накопительную скидку, а также улучшили производительность и стабильность работы системы.
  • Сборка DIAFAN.CMS 7.1.3
  • 12 января
  • После выхода сборки 7.1 мы выпустили уже три патча, в каждом из которых улучшаем административную часть сайта. Сборка DIAFAN.CMS 7.1.3 уже доступна к установке. 
Все новости

Форум

Перейти на форум