bialix_ (28.10.2008 14:11, просмотров: 387) ответил Shura на Всем привет. Возникла необходимость документирования софта, сдаваемого разработчиком. Ну с исходниками всё ясно, а как поступать с вспомогательной инфой (алгоритмы, блок-схемы, etc.) не совсем ясно. Как у вас решается этот вопрос?
Шура, начните для начала с внедрения ревью кода. Это когда другой программист смотрит незамутненным взглядом на код Творца и начинает задавать всякие дурацкие вопросы: а это что? а это зачем? а что это делает? Цель ревью -- просмотр и оборение кода. Причем ревьювер должен дать окончательный одобрям и только после этого работа считается законченной и оплаченной. Лучше если ревьюверов будет парочка. По прошествии нескольких ревью будет видно что страдает в коде для понимания незамутненным взглядом.
Я заставляю описывать протоколы, алгоритмы и сценарии работы в виде соответствующих страничек в вики (юзаем Трак). Поскольку рядом лежат и исходники, на которые можно посмотреть из Трака и даже сделать ссылку, то все становится гораздо симпатичнее. Плюс для сишного кода конечно doxygen.
Вся сопроводительная документация тоже подвергается просмотру и ревью.
Вместо Трака вам могут посоветовать Redmine или еще что. Можно просто вики движок в сетке конторы поднять. Вариантов масса.
Только это все надо делать регулярно, соответственно на начальных порах придется всех заставлять и никому не делать поблажек. Слабые духом могут начать даже подумывать об увольнении. Весна покажет кто где срал.