Нужен совет по документированию сайта LAMP

Мне нужно документировать свой веб-сайт. Это музыкальный веб-сайт на Linux/Apache/MySQL/PHP на AWS. Мне нужно документировать все: архитектура (5 серверов), база данных (более 100 таблиц), классы php, программные конструкции и потоки процессов. Я знаком с phpdoc. В противном случае, я не уверен, какие инструменты лучше. Мне бы хотелось, чтобы инструменты были совместимы с отраслевым стандартом UML.

1 ответ

Я бы сказал, что есть два важных критерия, которым должен удовлетворять инструмент:

  • По крайней мере, один человек в команде должен иметь опыт использования инструмента.
  • Данные должны храниться в текстовых файлах.

Второй критерий таков, что вы можете хранить файлы в системе контроля версий. Отслеживание изменений в двоичных файлах не требуется.

Если несколько инструментов удовлетворяют обоим критериям для вас, пусть люди, имеющие опыт работы с инструментами, придут к соглашению, какой из них использовать.

Другие вопросы по тегам