Как правильно создать документацию проекта на php, extjs?
Всем привет!
Я начинающий php developer.
В данный момент заканчиваю свой первый проект на php , extjs, oracle db. Естественно у меня проблемы с документацией, то есть честно говоря даже нет документации. Есть только комментарии к функциям классам итд.
В последнее время у меня возникло сильное желание как-то задокументировать код проекта.
Знаю, что некоторые считают что я трачу время впустую, но все-таки, хочется иметь хорошо задокументированный код с иллюстрациями , чтобы менеджеры и новые сотрудники понимали о чем проект с минимальным вмешательством создателя.
Что имеем:
1) сайт example.com
2) код на php (yii), extjs
Как я вижу документацию:
1) вся документация о проекте на docs.example.com. (Естественно чтобы посмотреть содержимое нужно пройти аутентификацию)
2) любое изменение комментарии автоматически отражается на сайте документации
3) я не знаю есть ли такая возможность: автоматически показать весь бизнес-процесс на BPMN и/или UML на сайте ( конечно можно самому нарисовать диаграммы, но интересно есть ли такая программу которая делает все это автоматом) ну и и.т.д
Начал читать про doxygen, но я надеюсь что профессионалы и те кто имел дело с этим укажут мне правильный путь.
Confluence - там есть куча плагинов, UML и так далее. Возможно как-то можно автоматизировать, я это делал уже давно и не помню. Можно также интегрировать в конфлю www.draw.io
Минус - платно, но нескольких пользователей вроде как не дорого. Плюсов кууча.
Средний
