1
Реализация / Создание технической документации для ПО
« : 31 Октября 2009, 23:42:21 »
Доброго времени суток.
Очень интересует вопрос организации процесса документирования разработки нового программного обеспечения (написания технической документации). Работаю в компании которая занимается написанием ПО для медицины (являюсь руководителем отдела), хотелось бы поднять уровень документирования систем у себя на более высокий уровень. Сейчас документирование выражено написанием комментариев в исходном коде программы и в БД (пакеты, функции). Нет единого документа который бы описывал все функции системы в полном объеме и давал понимание как взаимодествуют эти функции.
Уже есть много разработок которые не документированы вообще или документирова очень плохо, и у разработчиков уходить много времени на изучение исходного кода, что бы исправить ошибку в логике программы или дописать новые функции, спасает то что есть еще люди которые тем или иным образом учавствовали в разработке этого ПО. Сейчас должен начаться новый проект, соответственно хочется начать сразу и правильно что бы потом как можно меньше пришлось переделывать...
Хотелось бы услышать рекомендации или личный опыт организации такого процесса. Если есть возможность (было бы просто замечательно) хочется почитать какой-нибудь составленный документ описывающий систему с точки зрения разработчика (написаный разработчиком для разработчиков).
Изучая данную проблему я нашел описание структуры Modern SRS Package у Леффингуэлла. Документ мне в целом понравился... но мне кажется что он очень сложный и запутанный (и по этому документу есть ряд вопросов по его организации и заполнению). Использовал ли кто эту структуру для создания технической документации?
PS
Если я правильно понимаю то данный документ должен писаться всеми участниками проекта:
руководитель проекта - описывает бизнес логику, создает модели, фиксирует пользовательские и бизнес требования;
разработчики - описываю функции реализующие пользователькие требования, интерфейсы функций и взаимодествия между функциями
Очень интересует вопрос организации процесса документирования разработки нового программного обеспечения (написания технической документации). Работаю в компании которая занимается написанием ПО для медицины (являюсь руководителем отдела), хотелось бы поднять уровень документирования систем у себя на более высокий уровень. Сейчас документирование выражено написанием комментариев в исходном коде программы и в БД (пакеты, функции). Нет единого документа который бы описывал все функции системы в полном объеме и давал понимание как взаимодествуют эти функции.
Уже есть много разработок которые не документированы вообще или документирова очень плохо, и у разработчиков уходить много времени на изучение исходного кода, что бы исправить ошибку в логике программы или дописать новые функции, спасает то что есть еще люди которые тем или иным образом учавствовали в разработке этого ПО. Сейчас должен начаться новый проект, соответственно хочется начать сразу и правильно что бы потом как можно меньше пришлось переделывать...
Хотелось бы услышать рекомендации или личный опыт организации такого процесса. Если есть возможность (было бы просто замечательно) хочется почитать какой-нибудь составленный документ описывающий систему с точки зрения разработчика (написаный разработчиком для разработчиков).
Изучая данную проблему я нашел описание структуры Modern SRS Package у Леффингуэлла. Документ мне в целом понравился... но мне кажется что он очень сложный и запутанный (и по этому документу есть ряд вопросов по его организации и заполнению). Использовал ли кто эту структуру для создания технической документации?
PS
Если я правильно понимаю то данный документ должен писаться всеми участниками проекта:
руководитель проекта - описывает бизнес логику, создает модели, фиксирует пользовательские и бизнес требования;
разработчики - описываю функции реализующие пользователькие требования, интерфейсы функций и взаимодествия между функциями