Answer the question
In order to leave comments, you need to log in
How to create project documentation in php, extjs?
Hello!
I am a beginner php developer.
At the moment I am finishing my first project on php , extjs, oracle db. Naturally, I have problems with the documentation, that is, to be honest, there is not even documentation. There are only comments to functions, classes, etc.
Recently, I have had a strong desire to somehow document the project code.
I know that some people think that I'm wasting my time, but still, I want to have well-documented code with illustrations so that managers and new employees understand what the project is about with minimal intervention from the creator.
What we have:
1) site example.com
2) code in php (yii), extjs
As I see the documentation:
1) вся документация о проекте на docs.example.com. (Естественно чтобы посмотреть содержимое нужно пройти аутентификацию)
2) любое изменение комментарии автоматически отражается на сайте документации
3) я не знаю есть ли такая возможность: автоматически показать весь бизнес-процесс на BPMN и/или UML на сайте ( конечно можно самому нарисовать диаграммы, но интересно есть ли такая программу которая делает все это автоматом)
ну и и.т.д
Начал читать про doxygen, но я надеюсь что профессионалы и те кто имел дело с этим укажут мне правильный путь.
Спасибо за внимание
Answer the question
In order to leave comments, you need to log in
Confluence - there are a bunch of plugins, UML and so on. Perhaps somehow you can automate, I did it for a long time and do not remember. You can also integrate www.draw.io into the confluence
Minus - for a fee, but several users seem to be not expensive. Bunch of pluses.
Didn't find what you were looking for?
Ask your questionAsk a Question
731 491 924 answers to any question