Отслеживание изменений в (функциональном) проектном документе - PullRequest
5 голосов
/ 24 марта 2009

Я ищу хороший способ держать проектный документ в актуальном состоянии с последними решениями.

Мы небольшая команда (два разработчика, гейм-дизайнер, графический дизайнер, менеджер проектов, продавец). Большинство наших проектов длятся пару месяцев. В начале проекта создается дизайн, но мы обычно делаем изменения или новые решения на протяжении всего проекта. Большинство из этих изменений являются улучшениями, поэтому мы хотим сохранить наш процесс таким. (Если измененный дизайн требует большего времени, об этом обычно заботятся, так что с деталью все в порядке)

Однако в настоящее время у нас нет хорошего способа зафиксировать изменения в исходном проектном документе, и это приводит к тому, что первоначальный проект быстро отбрасывается в качестве источника при кодировании. Это, конечно, пустая трата усилий.

В настоящее время нашими документами являются OpenOffice / Word, и наилучшим способом отслеживания изменений в этих документах, вероятно, будет добавление списка изменений в верхнюю часть документа и внесение изменений в текст параллельно - на самом деле это не вариант думать как идеал.

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

Кто-нибудь знает хороший способ отслеживать подобные изменения и сохранять проектный документ ценным ресурсом на протяжении всего проекта?

РЕДАКТИРОВАТЬ: В настоящее время мы в основном полагаемся на изменения в оригинальном дизайне, которые вносятся в багтрекер, поэтому они по крайней мере где-то .

РЕДАКТИРОВАТЬ: Связанный вопрос

Ответы [ 5 ]

4 голосов
/ 24 марта 2009

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

1 голос
/ 10 сентября 2009

Эта проблема была давней проблемой и в нашем магазине программирования. Самое смешное, что программисты склонны смотреть на это с неправильной точки зрения оптимизации: «держать все в одном месте». На мой взгляд, у вас есть две основные проблемы:

  • Описание изменений должно быть легко читаемым ("Так что же нового?")
  • Процесс должен быть оптимизирован для написания спецификации для согласования, а затем приступить к работе уже!

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

Лучший способ - никогда не трогать выпущенный документ. Не помещайте все в один файл, вы получите:

  • таблица истории страшных версий
  • вечный статус "черновик" ,
  • рассеянные несоответствия,
  • ужасно поспешные предложения и
  • дурно пахнущая смесь авторских стилей

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

С размером нашего проекта, это никогда не может работать, не так ли?

В моем самом большом проекте на данный момент я выпустил одну базовую спецификацию и 5 последовательных дополнений. Каждый из около 5 страниц. работал как шарм!

1 голос
/ 24 марта 2009

И openoffice, и word включают возможности для отображения / скрытия изменений в вашем документе. Предполагая, что есть сопротивление изменению, тогда это ваш лучший вариант - либо это, либо экспорт в текст и поместите его в любое программное обеспечение управления исходным кодом. \

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

0 голосов
/ 24 марта 2009

Используйте Google Docs. Это бесплатный веб-интерфейс, позволяющий пользователям в режиме реального времени выбирать, кто имеет доступ к вашим документам и сохраняет версии. Вы также можете загрузить все свои документы Word, и он преобразует их для вас. Для получения дополнительной информации: http://www.google.com/google-d-s/intl/en/tour2.html

0 голосов
/ 24 марта 2009

Я не знаю хороших бесплатных инструментов управления конфигурацией, но почему бы не поставить ваш дизайн под контроль исходного кода? Просто добавьте его в SVN, CVS или что вы используете. Это хорошо, потому что:

1) Это всегда актуально (если вы регистрируетесь, конечно)

2) Централизовано

3) Вы можете отслеживать изменения, используя встроенную функцию сравнения, доступную практически в любой системе управления источниками

Возможно, вам не нужно «предприимчивое» решение, но вы все равно небольшая команда разработчиков, поэтому для этой ситуации оно более чем идеально.

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

...