Який найкращий спосіб зберігати документацію, пов’язану з кодовим проектом?

У нас є багато документів, пов'язаних з нашою розробкою програмного забезпечення. До них відносяться такі речі, як вимоги, конструкторські документи, зовнішні PDF-файли, файли клієнтів, інструкції з тестування тощо. Наразі ці документи розкидані по всьому світу (вікі, "якесь місце в мережі", жорсткий диск місцевих розробників (!), і ще гірші місця).

Який найкращий спосіб відстежити їх? Оскільки ми використовуємо для своєї розробки візуальну студію (2010), і насправді у нас немає проектів, що не розробляють проект, я подумав, що було б чудовою ідеєю зберігати їх у "рішенні" VS, яке дозволило б їм бути контрольованим джерелом та загальнодоступним для всіх розробників.

Однак VS насправді не здається побудованим для цього. Якщо ви редагуєте будь-який файл документа, навіть той, який налаштовано зі властивостями збірки "None", "Не копіюйте", VS повинен відновити програмне забезпечення, перш ніж воно запуститься знову. Немає можливості створити "Документаційний проект" в рамках рішення. (Для цього ми використовуємо проект Empty C #). Visual Studio і Word / Excel плоскі не справляються з контролем джерел. Ви не можете переглянути зареєстрований файл, а потім вирішити внести зміни, попередньо не закриваючи файл, перейшовши до проекту та вручну перевіривши його перед внесенням змін. Це повільно і нудно в кращому випадку.

У будь-якому випадку це найкраще, що наша команда придумала, але я дуже хочу, щоб у мене було краще (безкоштовне) рішення.

Я не впевнений, чи існує єдиний "найкращий спосіб", але з вашого опису це здається, що кожен розробник веде свій власний спосіб зберігання документації. Отримайте закупівлю від кожного за одним методом зберігання документації, і це буде набагато простіше організувати її.

Окрім відповіді «знайти найкращий спосіб для вас», я б сказав, принаймні, шукати рішення, яке спрощує пошук документів . В одній компанії я створив вікі, який містив посилання на файли, кинуті на серверну землю, що раптом значно полегшило пошук та пошук документів, незалежно від того, де вони були. Після того, як інші користувачі почали використовувати вікі для пошуку документів, вони також почали її оновлювати або для посилання нових документів, або просто створивши запис wiki як документ.

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

Найкращим рішенням у моїй компанії було рішення створити вікі (ми використовуємо mediawiki). Він звикає багатьма способами - від традиційних вікі-записів до простого "Це - це ..." плюс документа Word. Шукати це дуже просто. Ми поступово збираємо дуже корисний сховище інформації.

Принаймні, у VS 2008 можна встановити тип конфігурації проекту C ++ (за властивостями проекту-> загальні-> параметри за замовчуванням) на Утиліта , і в цьому випадку VS нічого з цим не робить.

Ви намагалися використовувати такий проект у своєму C #-базі? (Можливо, у C # -проекту є щось подібне?)

Я, безумовно, погоджуюся, що тут немає жодного найкращого рішення. Але контроль версій! = Включений у рішення; більшість систем може працювати з речами, що не відповідають IDE. Отже, у більшості випадків документи можна тримати близько, але нотату.

Тепер, коли ми відкриваємо прикрі слова звички змінювати файли кожного разу, коли вони відкриваються, це вже інша проблема. . .

Ні, проекти Visual Studio (добре, C # і Vb.net) мають задумливий підхід до провідника рішень. VC ++ - набагато кращий, оскільки ви можете створювати віртуальні папки, які не прив’язані до дискового макета, і туди ж поміщати всілякі речі. Дурний Microsoft зламав це, намагаючись зробити його "легшим для розуміння".

Ви все ще можете помістити його в папку з рішеннями, але вона все ще не така гнучка, як ви, мабуть, захочете. Це означає, що вам потрібно знайти альтернативу, і мої рекомендовані альтернативи - це веб-інструменти. Якщо ви не хочете спробувати портал проектів (наприклад, Redmine), де ви можете зберігати документи та мати вікі, трекер помилок тощо тощо, перейдіть до інструменту управління документами. Щось на зразок Nuxeo або Owl добре зробить вам. Одного разу в Інтернеті ви маєте центральне місце, щоб люди знали, де шукати ці речі - це, мабуть, найважливіша частина управління документами. Якщо ви прив’яжете його до такої системи контролю версій, як субверсія (продовжуйте, ви не пошкодуєте про неї після VSS!), Тоді ви все одно зможете зв’язати документи з веб-інструментами і також керувати ними версії.

Subversion навіть має можливість виставляти сховище як папку webdav - тобто мережеву папку - так що ви можете розмістити їх на "мережевому диску", але вони все ще автоматично контролюють їх версію.

Я б все-таки поїхав на Redmine як на мої особисті переваги.