В помощь создания документации

    image Сначала эту заметку я хотел добавить только к себе, т.к. у меня перманентная проблема с документацией в проекте. Но решил поделиться со всеми.
    Мой проект большой, включает много подсистем. Требования постоянно меняются, а стиль работы ближе к agile.
    Как следствие, документация быстро теряет актуальность и я постоянно ищу методы для поддержания этой самой актуальности.

    Поэтому, если ваш проект на Django, то получать актуальную архитектуру БД вашего приложения за несколько секунд поможет вот такое вот дополнение: django-graphviz (ссылка)

    Пример того, что получается на выходе(с официальной страницы):
    image

    Если Вы более опытный в этих вопросах, то просьба поделиться своим личным практическим опытом в комментариях. Я думаю будет полезно всем, кто руководит и поддерживает и простые сайты и сложные.

    Similar posts

    AdBlock has stolen the banner, but banners are not teeth — they will be back

    More
    Ads

    Comments 7

      0
      Спасибо, будет интересно попробовать.
        +3
        Спасибо, может пригодиться. От себя добавлю пару слов о своих подходах(правда, к django отношения не имеют).
        1. если база MySQL можно использовать MySQL Workbench, весьма удобно (+ Forward/Reverse Engineering)
        2. для Java при создании документации Javadoc, можно использовать доклет UmlGraph, который в дополнение к текстовой документации построит также UML-диаграммы классов (с помощью того же Graphviz).
          +1
          В общем то тоже самое умеет django-extensions github.com/django-extensions/django-extensions/blob/master/docs/graph_models.rst наряду со многим другим =)

          Эх, все не доходят руки написать пост в стиле «наш опыт джанго»
            0
            Совершенно верно. Если кому-то будет полезно, то вот инструкция для установки этого варианта:

            Установить сначала в ОС пакет Graphviz (а также graphviz-devel), а для Django библиотеки django_extensions-0.7.1 и pygraphviz-1.1
            0
            Эта штука модели рисует или SQL-таблицы? Что, если у меня половина моделей хранится в NoSQL?
              0
              Модели

              Only users with full accounts can post comments. Log in, please.