powered by simpleCommunicator - 2.0.51     © 2025 Programmizd 02
Форумы / Управление процессом разработки ИС [игнор отключен] [закрыт для гостей] / Документирование разработки
5 сообщений из 5, страница 1 из 1
Документирование разработки
    #35058392
NUra
Скрыть профиль Поместить в игнор-лист Сообщения автора в теме
Участник
Доброго времени суток всем!

ситуация такая: один программист передает разработку другому. Как такого расписанного проекта со скопом задач нет, ТЗ писали внутри предприятия, поэтому написали, как написали... имеем то, что имеем.

Я рассуждаю с точки зрения программиста: как документировать свою разработку, чтобы по максимуму передать свои знания, максимально быстро подключить к работе нового специалиста. Нужно отдать ему исходники и документацию, чтобы больше он меня не беспокоил.

Что скажет сообщество?
...
Рейтинг: 0 / 0
Документирование разработки
    #35058486
Серж
Скрыть профиль Поместить в игнор-лист Сообщения автора в теме
Участник
Сначала надо максимально полно описать предметную область. Это необходимо. Если это будет, остальное можно уже по коду самому понять. Но этого не достаточно для быстрого включения в проект. Необходимо еще описать архитектуру ПО, все типовые технические решения и отдельно описать все отклонения. Ну и совсем в идеале все процессы из предметной области привязать к программе.

Если все делать по хорошему, то это очень большая работа.
...
Рейтинг: 0 / 0
Документирование разработки
    #35058529
NUra
Скрыть профиль Поместить в игнор-лист Сообщения автора в теме
Участник
полное описание действительно большая работа, соизмеримая в данном случае со всей выполненной работой... В моем случае работает один программист, поэтому планировалось, что работа будет в голове одного человека, а сейчас нужно передать то, что у него в голове.

Перефразирую вопрос, как уважаемое сообщество защищает свои небольшие разработки от смены разработчиков, удержание разработчиков в данном случае не подходит...
...
Рейтинг: 0 / 0
Документирование разработки
    #35058540
Фотография maxim_caban
Скрыть профиль Поместить в игнор-лист Сообщения автора в теме
Участник
1. Делаем "понятный" код. Так как зачастую это единственное что есть это очень важно. Рефакторинг если надо и т.д. Комментарии - по мере необходимости. Все не тривиальные вещи должны быть закоментированы. И конечно описание интерфейсов всех классов. Желательно с использованием автогенерации хелпа по исходникам.
2. Делаем принципиальную схему приложения (например в нотации UML). Это не должна быть схема всего на свете, но основную архитектуру должна описывать.
3. Делаем краткое описание предметной области и "функционала" системы. Это не полноценное ТЗ, а некий "быстрый" старт.

На мой взгляд это тот минимум, что поможет достаточно быстро войти в работу новому человеку. Порядок изучения конечно обратный - 3-2-1.

Если имеется еще что-то (нормальное ТЗ, нормальная модель системы, описание БП, модульные тесты, документация пользователя, ...) то это конечно большой плюс. Но к сожалению бывает это не часто :(
...
Рейтинг: 0 / 0
Документирование разработки
    #35058701
Фотография Big17
Скрыть профиль Поместить в игнор-лист Сообщения автора в теме
Участник
Я бы еще добавил спецификцию требований - перечень (дерево) требований со статусами и приоритетами - что выполнено, а что нужно выполнить... Это поможет не только описать текущую ситуацию, но и определить приоритеты дальнейшего развития программы (она ведь будет развиваться?)
...
Рейтинг: 0 / 0
5 сообщений из 5, страница 1 из 1
Форумы / Управление процессом разработки ИС [игнор отключен] [закрыт для гостей] / Документирование разработки
Целевая тема:
Создать новую тему:
Автор:
Закрыть
Цитировать
Найденые пользователи ...
Разблокировать пользователей ...
Читали форум (0):
Пользователи онлайн (0):
x
x
Закрыть


Просмотр
0 / 0
Close
Debug Console [Select Text]