Как документировать существующее решение?

Question

[Rewertkin]

Добрый день.
На данный момент есть система (БД+Веб интерфейс+ios\android приложение). Т.к. проект потихоньку разрастается, а разработчики уже плохо помнят, что и где они меняли, + проблема по вводу новых сотрудников в штат, было принято решение по документированию всего решения. Какие инструменты лучше всего для этого подойдут?

Существуют какие либо методологии по такому reverse документированию?

Answer 1

[Станислав Дубровский]

Как вариант, поднять внутреннюю wiki. По опыту скажу, лично мне, как программисту удобней всего было работать именно с wiki.

Comments

[Saboteur]

Плюсую
Создаете вики,
Архитекторы и сеньоры собираются на брейншторм, чтобы определить общую структуру и категории, после чего можно накидать структуру на вики в виде пустых страничек, но уже разложенным по категориям, определить общий стиль и сроки.
Чаще всего кто-то по согласованию берет и делает 1-2 странички каких-нибудь не очень сложных компонентов, которые служат примером как надо писать.

Затем программисты которые кодят нужные компоненты и тестировщики, которые работают с requirements заполняют Wiki. В зависимости от размера проекта - пару часов/дней/месяцев/лет - и готово.

Answer 2

[Эдуард Тибет]

Чтобы понять, какие решение вам надо, вам надо задать себе следующие вопросы:
1. Предполагается ли документацию выносить наружу?
2. В каких выходных форматах вы хотите поставлять документацию? Предполагается ли печатка (как класс)?
3. Предполагается ли многоуровневая документация (т.е., например, несколько модулей для клиента А, несколько для клиента Б и т.п.)?
4. Надо ли документировать API (руками или автоматически)?
5. Кто будет осуществлять поддержку всего этого хозяйства?
6. Какой объем (примерно) сейчас и какой объем будет после года?
7. Надо ли хранить версионность всего этого добра?

Есть еще вопросы, но на текущий момент пока хватит :)