Dir (30.10.2008 03:38, просмотров: 103) ответил Shura на Всем привет. Возникла необходимость документирования софта, сдаваемого разработчиком. Ну с исходниками всё ясно, а как поступать с вспомогательной инфой (алгоритмы, блок-схемы, etc.) не совсем ясно. Как у вас решается этот вопрос?
Поразил факт: 7 программеров и все программят на ассемблере. Неужели это так необходимо? У нас такое же примерно количество человек, но при приеме на работу если человек не умеет на С, то его кандидатура в большинстве случаев даже не рассматривается. И не потому, что задачи не допускают асма. Как правило программы не очень большие, а именно из-за трудностей организовать совместную работу и сопровождение. А так выделили девочку-программистку для ручного (Exel) ведения архива программ и внесения регистрации изменений (а ля ручное SVN) и на этом успокоились. Как-то само собой устаканился и общий фирменный стиль оформления исходников. Ничего особенного - описано во всех руководствах по С: шапка с атрибутами (программист, дата, версия, среда) и кратким описанием файлов проекта, хедеры к каждому файлу с подробным описанием переменных, осмысленные имена переменных и п/п, достаточный минимум комментариев и (обязательно!) отсутствие выебежа при программировании если без этого можно обойтись, описание файла программирования и фьюзов и т.п. Никакой другой документации к программе, кроме проектной, не ведем. Периодически встает вопрос о системе контроля версий, но не очень печет, а потому вопрос как спонтанно встает так и отпадает. Проверяет программу на соответсвие стиля та же девочка-программист при сдаче программы в архив. Иногда заставляет кое-что исправлять. Начальство предупредило, что дата сдачи проекта в архив считается моментом завершения работы и всем пришлось согласиться.
Был форс-мажор пару лет назад. Погиб в автомобильной аварии ведущий сотрудник. На удивление проблема распределения его разработок между остальными решилась практически безболезненно. Разобраться с проектами даже с вставками на асме цифровых фильтров особого труда не составило.
Так что главное, ИМХО, спокойно и без шума организовать работу и объяснить людям, что некоторые формальные требования к проекту это не выпендреж начальства, а жизненная необходимость.
PS. Да, описание самой идеи прибора, всех формул и нюансов работы - в инструкции по эксплуатации. Без программиста эта инструкция не пишется.