Проект заморожен - что я должен оставить людям после себя?

Так что проект, над которым я работал, теперь будет заморожен на неопределенный срок. Возможно, что если и когда проект снова разморозится, он не будет назначен мне или кому-либо из текущей команды. На самом деле, мы унаследовали проект после того, как он был заморожен ранее, но предыдущая команда ничего не оставила, чтобы помочь нам понять даже основные потребности проекта, поэтому мы потратили много времени на то, чтобы хорошо узнать проект. Мой вопрос: как вы думаете, что мы должны сделать, чтобы помочь людям после нас лучше понять потребности проекта, что мы сделали, почему мы это сделали и т. Д. Я открыт для других идей о том, почему мы должны уйти некоторые треки для других, которые также будут работать над этим проектом.

Некоторые шаги, которые мы уже предприняли:

• техническая документация (не полная, но, по крайней мере, есть);
• история системы контроля версий;
• оценки того, какие части проекта нуждаются в улучшении и почему мы так думаем;
• куча юнит-тестов.
• Отслеживание проблем со всеми билетами, которые мы сделали ( РЕДАКТИРОВАТЬ )

Что вы думаете о том, что мы уже подготовили и что еще мы можем сделать?

Еще несколько вещей, чтобы рассмотреть

• Является ли структура каталогов проекта вменяемой? Вы пересмотрели комментарии к коду? Является ли журнал коммитов каким-то презентабельным?
• Общий обзор целей (в отличие от технического, который вы начали), Консультирование по проекту, истории проекта (цикл его разработки, предыдущие менеджеры проектов, список сотрудников, требования / спецификация функций)
• UML-диаграммы, диаграммы классов, диаграммы рабочих процессов!
• Причины, по которым проект был заморожен, всегда хороши.
• Среда разработки, IDE, которые использовались, инструменты сборки, они описаны в технических документах, верно?

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

Вещи, которые я хотел бы иметь при подборе проекта, написанного кем-то другим:

Инструкции по сборке, включая последние известные рабочие версии всех инструментов в наборе инструментов. Компиляторы, интегрированные среды разработки и т. Д. Со временем меняются, и с ними гораздо проще работать, если предыдущие разработчики оставляли мне инструкции о том, как приступить к работе.

Выполнить инструкции среды - что должно быть на месте, чтобы запустить эту вещь? Упоминание о том, какие версии снова полезны. Недавно я поднял что-то, что требовало определенного набора файлов, чтобы быть в определенном месте, и я должен был опросить других разработчиков, чтобы выяснить это. Ничего страшного, так как другой разработчик был доступен, но если бы его не было, то это было бы проблематично.

Некоторая уверенность в том, что код, переданный в хранилище, действительно выполняет извлечение и сборку. Однажды я подобрал проект, в котором предыдущие разработчики (к счастью, все еще рядом) делали действительно странные вещи с Makefiles, так что вы не могли построить проект из чистой проверки. Само собой разумеется, я сначала должен был исправить ЭТО, прежде чем я мог фактически сделать любую работу. Если бы предыдущие разработчики не были доступны, это могло бы занять гораздо больше времени, чтобы преодолеть это препятствие.

Общее заявление о намерениях проекта. Для чего эта часть программного обеспечения? Короче говоря разумно, но какой-то обзор может быть действительно полезным.

ScreenCast

Когда я оставил свою последнюю работу, я на самом деле делал неотредактированные скринкасты, которые, насколько я слышал, очень помогли привлечь новых людей. Я взял свою команду в комнату, установил конденсаторный микрофон и объяснил им все, что я знал о проекте во время записи звука и экрана. Затем я позволил им задать мне вопросы об этом. Мы смогли получить гораздо больше информации, чем могли бы, если бы я сел и попытался печатать так быстро, как мог весь день.

Если вы знакомы с информацией, добавьте Бизнес-требования.

1. Чего хотел клиент?
2. Как изменения способствовали этому?
3. Какие были или есть некоторые проблемы в удовлетворении потребностей клиентов?
4. Какие потребности не были удовлетворены и почему?

Образ виртуальной машины (то есть vm-ware) работающей автономной системы разработки может быть весьма ценным.

В прошлом году меня попросили исправить код vb3. Было довольно сложно создать работающую систему с vb3, windows95 и множеством установленных контроллеров ole. Через неделю я сдался :-(

[Обновление] Кто-нибудь экспериментировал с преобразованием старых образов виртуальных машин, чтобы их можно было воспроизводить в новом проигрывателе виртуальных машин?

Вы также должны учесть, что больше не возможно запускать очень старый образ на современном оборудовании / гостевой ОС.