| Версия для печати темы
Нажмите сюда для просмотра этой темы в оригинальном формате |
| Форум программистов > УП: Общие вопросы > Тщательное документирование проекта... |
| Автор: Maxwell_Forrest 13.7.2010, 08:57 |
| Приветствую. Наша фирма частенько заказывает довольно крупные web-сайты и порталы, но, в основном, работу выполняют фрилансеры (которые могут неожиданно пропасть). Сейчас мы подумываем над тем, что бы заказать достаточно большой и дорогостоящий проект и у меня возникли вопросы по документированию. 1) На каком этапе лучше осуществлять документирование (во-время разработки или после)? 2) Кто должен этим заниматься: программисты или отдельно нанятый человек? 3) Можно ли требовать документирование каждого файлы, описание его назначения и функций, (проект на php) и тщательное документирование кода? 4) Что ещё можете предложить по документированию, что бы в дальнейшем можно было отдать проект на аутсорс? Заранее спасибо за ответы. P.S. Если дадите полезных ссылок или посоветуете книги - буду очень признателен. |
| Автор: patap 13.7.2010, 09:34 |
| слышал о таком как phpDocumentor, но сам никогда не пользовался. Думаю то что нужно http://www.phpdoc.org/, и http://www.wsdb.net/notes/phpdocumentor/ можно по-быстрому ознакомиться, ну и погуглить разумеется если мало инфы |
| Автор: Maxwell_Forrest 13.7.2010, 11:01 |
| patap, спасибо. Вечером подробнее ознакомлюсь. |
| Автор: EagleOne 10.8.2010, 08:17 | ||
1) Соблюдение программистом принятой нотации, правил именования классов, методов, идентификаторов и т.д. - это уже процесс документирования, такой код хорошо читается даже без комментариев. Написание комментариев к коду - это тоже документирование. Так что как минимум в процессе разработки,а в идеале до процесса разработки - например, написание ФС-ки (Функциональной спецификации) это уже документирование. 2) По большей частью сами разработчики. Инструкции для пользователей лучше будет, если тестеры напишут. 3) Нужно. 4) рядовым разработчикам нужна восновоном ФС-ка, ведущим разработчикам, руководителям проектов восновном ТЗ. |
| Автор: Sentox 30.10.2010, 01:00 |
| Да уж фонарь, |