Форум Сайтостроение Веб-строительство

На чём делать и как документировать

A
На сайте с 26.05.2007
Offline
74
Ayan
706

Вопрос к менеджерам проектов и программистам, работающим на фреймворках:

Планируется делать проект на фреймворке (вероятно Yii). Программист будет работать удалённо.

У меня довольно большой опыт работы с удалёнными разработчиками и я по себе знаю что рано или поздно такое сотрудничество заканчивается (человек может просто пропасть, устроиться на постоянную работу, переехать, сменить технологию программирования, поднять цены так что они для меня станут недоступны, заболеть и т.д.) поэтому один из главных для меня вопросов: преемственность. Что бы в случае необходимости можно было передать разработку. Предыдущие мои проекты были просто сайтами и работали на CMS поэтому найти человека для допиливания чего-либо труда не составляло.

Вопросы: какая нужна документация от программиста что бы было максимально просто передать проект другому программисту? Что документировать? Нужно ли что-то типа стандартов кодирования (как в экстремальном программировании)?

Вообще если проект сделан на фреймворке, это по-умолчанию означает что последующий разработчик будет терпимо относиться к коду предыдущего (он, скажем так, для него будет понятен)?

M2
На сайте с 11.01.2011
Offline
341
mark2011
#1

Ну скажем так.... тот программист, кто знаком с данным фреймворком, без труда поймёт код. А от комментариев - да просто в стиле phpDocumentor... я всегда так комментирую. Другое дело чтобы программист писал нормальные комментарии - что за функция, что она делает, входные/выходные параметры - это всё в обязательном порядке нужно описывать. Ибо тогда преемственности никакой не будет.

------------------- Крутые VPS и дедики. Качество по разумной цене ( http://cp.inferno.name/view.php?product=1212&gid=1 ) VPS25OFF - скидка 25% на первый платеж по ссылке выше
В DuckDuckGo теперь можно Какие фреймворки стоит освоить В коде Instagram обнаружена
bay_ebook
На сайте с 28.05.2010
Offline
111
bay_ebook
#2

Если разработка идет на фремворке и прогер не пытается переписать ядро, а нормально пишет, то понят чего там - не проблема.

Документация - это не суть важно, главное, что бы по сути

А вот стиль кодирования - это как не странно более важно, причем какой стиль выбрать (CI, Zend и тд) не важно, но если выбран - весь сайт должен быть написан так, а не часть с одинм стилем, вторая часть с другим.

Нужен прогер на php+mysql+понимание чужего кода? (/ru/forum/540660) Вам сюда PHP-шаман (http://php-shaman.pw/)
Исследование рынка CMS: какие Google рекомендует размещать видео Google: мы не делаем
A
На сайте с 26.05.2007
Offline
74
Ayan
#3

Благодарю, всё понятно.

Да рассматриваем ситуацию при которой новый разработчик безусловно знает этот фреймворк и имеет опыт работы с ним.

Нормальные комментарии о которых mark2011 сказал прямо в коде я так понимаю должны быть?

Про стиль кодирования да я понимаю, проблема в том, что если разработка и поддержка сайта ведётся несколько лет одним человеком, он сам развивается, у него может поменяться собственный стиль кодирования ))

Контроль соблюдения этих правил, требований со стороны менеджера проекта как лучше осущесталять? Самому смотреть код? Или попросить посмотреть ещё кого-то?

Яндекс раскрывает секреты борьбы Игорь Ашманов: Есть разные Артур Латыпов: «Трудолюбие и
[Удален]
#4

Ayan, посмотри вот этот стандарт оформления исходного кода: http://monstra.org/documentation/standards который принят у нас.

M2
На сайте с 11.01.2011
Offline
341
mark2011
#5
Ayan:
Нормальные комментарии о которых mark2011 сказал прямо в коде я так понимаю должны быть?

Да они в коде и есть. Документируются, как правило, классы и методы. Более подробно - на сайте phpDocumentor (это этот стиль).

Авторизуйтесь или зарегистрируйтесь, чтобы оставить комментарий