Как зарегистрировать существующий небольшой веб-сайт (веб-приложение), от и до? [закрытый]
2 ответа
Я бы начал с перечисления основных функций, которые приложение в настоящее время реализует (обновите начальные пункты списка).
Затем для каждого пункта списка запишите основные требования, связанные с этим пунктом.
Для каждого требования запишите:
- Что-нибудь необычное в этом конкретном требовании
- Где в коде реализовано это требование (какие файлы php, inc, таблицы)
Это даст вам некоторую возможность отслеживания иерархия
Характеристика => Требование => Реализация
Это также обеспечит хорошую основу для устранения проблем с воспоминаниями и записи ошибок.
Затем прокомментируйте каждую страницу php и inc.
Начните с заголовка, который описывает цель и какие требования из предыдущего списка удовлетворены (обратная прослеживаемость от кода к требованию).
Просмотрите каждый файл php / inc и прокомментируйте основные действия / решения / циклы, указав, что они пытаются выполнить, и любые предполагаемые конструктивные соображения (например, «предполагается, что ввод был подтвержден на предыдущем шаге»).
Комментируя исходный код, вы можете использовать такой инструмент, как PHPDoc , чтобы вы могли создавать документацию из комментариев.
Один из подходов может заключаться в организации серии передающих встреч. В них разработчик должен объяснять код для каждого раздела.
Он мог бы написать несколько заметок для подготовки к ним, но если другие разработчики также уделят несколько минут, это может помочь им понять код. Также на этих встречах будет возможность задать вопросы о неясных аспектах.
Не пытайтесь сделать весь сайт за один присест. Разбейте его на два небольших куска, сгруппированных как-нибудь - по функциям или по площади. Это означает, что других ваших разработчиков не засыпают слишком большим объемом информации за один раз, первоначальный разработчик может сосредоточиться на одной области в определенный момент времени, и у вас есть шанс продолжить работу после встречи.
Даже если ничего не «прилипнет» сразу, вы наверняка познакомитесь с сайтом, когда вернетесь к нему позже.
Другой подход может заключаться в том, чтобы разработчик провел серию коротких презентаций о сайте и о том, как он был построен. Это может побудить его вспомнить, почему он выбрал именно такой подход. Это бесценно при взгляде на код. Если вы знаете, какую проблему он пытался решить, это будет намного легче понять.