コードプロジェクトに関連付けられたドキュメントを保存する最良の方法は何ですか?


10

ソフトウェア開発に関連するドキュメントはたくさんあります。これらには、要件、設計ドキュメント、外部PDF、顧客ファイル、テスト手順などが含まれます。現在、これらのドキュメントは場所(wiki、「ネットワーク上の場所」、ローカル開発者のハードドライブ(!)、そしてさらに悪い場所)。

それらを追跡する最良の方法は何ですか?開発にはビジュアルスタジオ(2010)を使用しており、プロジェクトに非開発者が実際にいないため、それらをVS "ソリューション"内に保存して、ソース管理され、すべての開発者が普遍的にアクセスできるようにします。

ただし、VSは実際にこれを行うように構築されていないようです。ドキュメントファイルを編集する場合、ビルドプロパティが[なし]、[コピーしない]でセットアップされている場合でも、VSはソフトウェアを再構築してから再度実行する必要があります。ソリューション内に「ドキュメントプロジェクト」を作成する方法はありません。(これには空のC#プロジェクトを使用します)。Visual StudioとWord / Excelフラットは、ソース管理がうまく機能しません。チェックインされたファイルを表示して、最初にファイルを閉じてプロジェクトに移動し、変更を行う前に手動でチェックアウトしないと、変更を行うことはできません。遅くても退屈な作業です。

とにかくこれは私たちのチームが考え出した最高のものですが、私は本当にもっと良い(無料の)ソリューションがあったらいいのにと思います。


あなたのチームの大きさは?
ジェフ

今、3-4人います。
デビッド

具体的にどのバージョン管理を使用していますか。それを管理するためにVisual Studioを使用することに関係しているソース管理については知りません。
Earlz

私が作業している場所では、コードを格納するためにTFSを使用し、ドキュメンテーション、テスト計画などのためにSharePointを使用します
ジョブ

4
PDFなどのドキュメントをVSSに入れることはお勧めしません。また、ソースコードをVSSに入れることもお勧めしません。
Carson63000 2011

回答:


3

単一の「最善の方法」があるかどうかはわかりませんが、あなたの説明から、すべての開発者がドキュメントを格納する独自の方法を行っているように思えます。ドキュメントを保存する単一の方法で全員から賛同を得れば、整理しておくのがはるかに簡単になります。

「あなたに最適な方法を見つける」という回答に加えて、少なくともドキュメントの検索を簡単にするソリューションを探すことをお勧めします。ある会社で、サーバーランドに関するすべてのファイルへのリンクを含むWikiを設定しました。これにより、どこにいてもドキュメントを検索して見つけることが非常に簡単になりました。他のユーザーがWikiを使用してドキュメントを検索し始めると、新しいドキュメントをリンクするか、ドキュメントとしてWikiエントリを作成するだけで、Wikiを更新し始めました。

ドキュメントと連携して機能する無料のバージョン管理システムについて知っている人がいれば、ぜひ聞いてください。私の頭の上の唯一のことは、Sharepointです。これは完全に無料ではありません。私は、人々が「アーカイブ」フォルダを持ち、ファイルの過去のリビジョンを単にそのフォルダに入れ、最新のリビジョンが「アーカイブ」と同じフォルダレベルにある非公式のバージョン管理システムを見てきました。


私たちの「wiki」ソリューションは、ネットワーク共有へのリンク(またはネットワーク上のファイルへの直接リンク)のいずれかです。欠点は、そのバージョン管理がないことです。または、ファイルをwikiにダウンロード/編集/アップロードします。タイプミスを修正するために編集したいときはいつでも10ステップのプロセス
デビッド

多くの無料のSharePoint代替案(より良い方法です!):設定が簡単なNuxeoを試してください。または、必要に応じて、より強力な何かを求めるAlfresco。
gbjbaanb

お使いのマシンにインストールされているGoogle検索は、物を見つけるのに不思議です。

3

私の会社で最もうまくいった解決策は、wikiをセットアップすることでした(私たちはmediawikiを使用しています)。従来のwikiエントリから単純な「これは...」に加えてWord文書まで、さまざまな方法で使用されます。検索はとても簡単です。非常に便利な情報のリポジトリを徐々に構築しています。


私たちはdoku-wikiを使用しようとしましたが、使用するのは非常に退屈であり(単語の入力ミスを修正するのは10の退屈なステップです)、誰が何を編集しているかに関するマルチユーザーサポートはありません。また、ファイルサイズとファイル拡張子に関する多くの警告と制限があり、実際には役に立たなかっただけです。社内の他のユーザーからの利用については賛同を得られませんでした。大きな可能性を秘めていますが、残念ながら私の会社にはありません。
David

1

少なくともVS 2008では、C ++プロジェクトの構成タイプ(プロジェクトのプロパティ->一般->プロジェクトのデフォルト)をUtilityに設定できます。この場合、VSはそれに対して何もしません。

このようなプロジェクトをC#ベースのソリューションで使用しようとしましたか?(たぶんC#プロジェクトには似たようなものがありますか?)


0

ここで最善の解決策が1つだけではないことは間違いありません。しかし、バージョン管理!=はソリューションに含まれています。ほとんどのシステムはIDEを超えて処理できます。そのため、ほとんどの場合、ドキュメントを近くに保つことができますが、内部はできません。

さて、ファイルが開かれるたびにファイルを変更するという煩わしい言葉の習慣を乗り越えることは別の問題です。。。


0

いいえ、Visual Studio(まあ、C#とVb.net)プロジェクトには、ソリューションエクスプローラーに対する頭の痛いアプローチがあります。VC ++の方がはるかに優れています。ディスクレイアウトに関連付けられていない仮想フォルダーを作成し、そこにあらゆる種類のものを配置できるからです。愚かなマイクロソフトはそれを「理解しやすく」しようとすることでそれを破った。

あなたはまだそれを「ソリューションフォルダ」に置くことができますが、それでもおそらくあなたが望むほど柔軟ではありません。それはあなたが代替案を見つける必要があることを意味し、私の推奨代替案はウェブツールです。ドキュメント保存し、Wiki、バグトラッカーなどを用意できるプロジェクトポータル(Redmineなど)を試したくない場合は、ドキュメント管理ツールを使用してください。NuxeoやOwlのようなものがうまくいきます。いったんWebになると、中心的な場所になり、人々がこれらのものを探す場所を知ることができます-これはおそらくドキュメント管理の最も重要な部分です。それをsubversionのようなバージョン管理システムに結び付ければ(続けて、VSSの後でそれを後悔することはありません!)、ドキュメントをWebツールにリンクし、それらをバージョン管理することもできます。

Subversionには、リポジトリをwebdavフォルダー(ネットワークフォルダー)として公開する機能もあります。そのため、それらを「ネットワークドライブ」に置いても、バージョンは自動的に制御されます。

私の個人的な好みとして、まだRedmineに行きます。

弊社のサイトを使用することにより、あなたは弊社のクッキーポリシーおよびプライバシーポリシーを読み、理解したものとみなされます。
Licensed under cc by-sa 3.0 with attribution required.