@Rewertkin

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

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

Существуют какие либо методологии по такому reverse документированию?
  • Вопрос задан
  • 586 просмотров
Пригласить эксперта
Ответы на вопрос 2
@Vusluk
Front-End разработчик; электронщик
Как вариант, поднять внутреннюю wiki. По опыту скажу, лично мне, как программисту удобней всего было работать именно с wiki.
Ответ написан
eduardtibet
@eduardtibet
Technical Writer / Documentation Engineer
Чтобы понять, какие решение вам надо, вам надо задать себе следующие вопросы:
1. Предполагается ли документацию выносить наружу?
2. В каких выходных форматах вы хотите поставлять документацию? Предполагается ли печатка (как класс)?
3. Предполагается ли многоуровневая документация (т.е., например, несколько модулей для клиента А, несколько для клиента Б и т.п.)?
4. Надо ли документировать API (руками или автоматически)?
5. Кто будет осуществлять поддержку всего этого хозяйства?
6. Какой объем (примерно) сейчас и какой объем будет после года?
7. Надо ли хранить версионность всего этого добра?

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

Войдите, чтобы написать ответ

Войти через TM ID
Похожие вопросы