Каков наилучший способ хранения документации, связанной с проектом кода?

У нас есть много документов, связанных с нашей разработкой программного обеспечения. К ним относятся такие вещи, как требования, проектные документы, внешние PDF-файлы, файлы клиентов, инструкции по тестированию и т. Д. В настоящее время эти документы разбросаны повсюду (вики, «какое-то место в сети», жесткий диск локальных разработчиков (!), и даже в худших местах).

Какой лучший способ отследить их? Так как мы используем Visual Studio (2010) для нашей разработки, и у нас на самом деле нет сторонних разработчиков, я подумал, что будет хорошей идеей сохранить их в «решении» VS, которое позволит им быть контролируемым источником и универсально доступным для всех разработчиков.

Тем не менее, VS действительно, похоже, не создан для этого. Если вы редактируете какой-либо файл документа, даже тот, который настроен со свойствами сборки «Нет», «Не копировать», VS должен перестроить программное обеспечение, прежде чем оно запустится снова. Невозможно создать «Проект документации» в рамках решения. (Для этого мы используем пустой C # проект). Visual Studio и Word / Excel flat не обеспечивают хорошее управление исходным кодом. Вы не можете просмотреть зарегистрированный файл, а затем принять решение о внесении изменений, не закрывая сначала файл, не переходя в проект и не проверяя его вручную перед внесением изменений. Это медленный и утомительный в лучшем случае.

В любом случае, это лучшее, что придумала наша команда, но мне бы очень хотелось, чтобы у меня было лучшее (бесплатное) решение.

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

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

Я хотел бы услышать от кого-либо еще, если они знают о бесплатных системах контроля версий, которые хорошо работают с документами. Единственное, что приходит мне в голову, это Sharepoint, который не совсем бесплатный. Я видел неофициальные системы управления версиями, в которых люди имеют папку «Архив» и просто помещают прошлые версии файла в эту папку, причем самые последние версии находятся на том же уровне папок, что и «Архив».

Лучшим решением в моей компании было создание вики (мы используем mediawiki). Он используется во многих отношениях, от традиционных вики-записей до простого «Это ...» и документа Word. Это очень легко искать. Мы постепенно создаем очень полезное хранилище информации.

По крайней мере, в VS 2008 вы можете установить тип конфигурации проекта C ++ (в свойствах проекта-> общие-> настройки по умолчанию) на Utility , и в этом случае VS ничего с этим не делает.

Вы пытались использовать такой проект в своем решении на C #? (Может, у C # -проекта есть что-то похожее?)

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

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

Нет, проекты Visual Studio (ну, C # и Vb.net) имеют тупиковый подход к исследователю решений. VC ++ one НАМНОГО лучше, так как вы можете создавать виртуальные папки, которые не привязаны к разметке диска, и помещать туда все виды вещей. Глупая Microsoft сломала его, пытаясь сделать его «проще для понимания».

Вы по-прежнему можете поместить его в «папку с решениями», но он все еще не так гибок, как вы, вероятно, захотите. Это означает, что вы должны найти альтернативу, и мои рекомендуемые альтернативы - это веб-инструменты. Если вы не хотите пробовать портал проекта (например, Redmine), где вы можете хранить документы и иметь вики, баг-трекер и т. Д., То выбирайте инструмент управления документами. Что-то вроде Nuxeo или Owl поможет вам. Когда-то веб-сайт станет центральным местом, чтобы люди знали, где искать эти вещи - это, вероятно, самая важная часть управления документами. Если вы свяжете его с системой контроля версий, такой как Subversion (продолжайте, вы не пожалеете об этом после VSS!), Тогда вы все равно сможете связать документы с веб-инструментами и контролировать их тоже.

Subversion даже имеет возможность выставлять репозиторий как папку webdav, т.е. как сетевую папку, так что вы можете поместить их на «сетевой диск», но при этом по-прежнему автоматически контролировать их версию.

Я бы по-прежнему выбрал Redmine в качестве своего личного предпочтения.