코드 프로젝트와 관련된 문서를 저장하는 가장 좋은 방법은 무엇입니까?


10

소프트웨어 개발과 관련된 많은 문서가 있습니다. 여기에는 요구 사항, 디자인 문서, 외부 PDF, 고객 파일, 테스트 지침 등이 포함됩니다. 현재 이러한 문서는 모든 장소 (위키, "네트워크상의 일부 장소", 로컬 개발자 하드 드라이브 (!))에 흩어져 있습니다. 더 나쁜 곳).

그들을 추적하는 가장 좋은 방법은 무엇입니까? 우리는 개발을 위해 Visual Studio (2010)를 사용하고 실제로 프로젝트에 비 개발자가 없으므로 VS "솔루션"에 저장하는 것이 좋습니다. 소스로 제어되고 모든 개발자가 보편적으로 액세스 할 수 있어야합니다.

그러나 VS는 실제로이 작업을 수행하도록 구축되지 않은 것 같습니다. 빌드 속성이 "없음", "복사하지 않음"으로 설정된 문서 파일을 편집하는 경우 VS는 소프트웨어를 다시 빌드하기 전에 소프트웨어를 다시 빌드해야합니다. 솔루션 내에서 "문서화 프로젝트"를 작성할 방법이 없습니다. (우리는 이것을 위해 Empty C # 프로젝트를 사용합니다). Visual Studio 및 Word / Excel flat은 소스 제어를 잘 수행하지 않습니다. 체크인 된 파일을 볼 수 없으며 먼저 파일을 닫고 프로젝트로 이동 한 후 변경하기 전에 수동으로 체크 아웃하지 않고 변경하기로 결정하십시오. 기껏해야 느리고 지루합니다.

어쨌든 이것이 우리 팀이 고안 한 최선이지만, 나는 더 나은 (무료) 솔루션을 원했습니다.


당신의 팀은 얼마나 큽니까?
Jeff

우리는 지금 3-4를 가지고 있습니다.
David

어떤 버전 관리를 구체적으로 사용하고 있습니까? Visual Studio를 사용하여 소스 컨트롤을 관리하는 소스 컨트롤을 모르겠습니다.
Earlz

내가 일하는 곳에서는 TFS를 사용하여 코드를 저장하고 문서, 테스트 계획 등에 SharePoint를 사용합니다.
Job

4
PDF와 같은 문서를 VSS에 넣지 않는 것이 좋습니다. 소스 코드를 VSS에 넣는 것도 권장하지 않습니다.
Carson63000

답변:


3

하나의 "최상의 방법"이 있는지 확실하지 않지만 설명에서 모든 개발자가 자신의 문서 저장 방법을 수행하는 것처럼 들립니다. 문서를 저장하는 단일 방법으로 모든 사람으로부터 바이 인을 확보 할 수 있으며 조직화가 훨씬 쉬워집니다.

"가장 좋은 방법을 찾으십시오"라는 대답 외에도 최소한 문서를 쉽게 검색 할 수있는 솔루션을 찾는 것이 좋습니다 . 한 회사에서 서버 랜드에 대한 모든 파일에 대한 링크가 포함 된 위키를 설정했는데, 그 결과 문서의 위치에 상관없이 문서를 훨씬 쉽게 검색하고 찾을 수있었습니다. 다른 사용자가 위키를 사용하여 문서를 찾은 후에는 새 문서를 링크하거나 문서로 위키 항목을 작성하여 문서를 업데이트하기 시작했습니다.

문서와 잘 작동하는 무료 버전 제어 시스템에 대해 알고 있다면 다른 사람들의 의견을 듣고 싶습니다. 내 머리 꼭대기에서 나오는 유일한 것은 Sharepoint인데, 이것은 정확히 무료가 아닙니다. 사람들이 "아카이브"폴더를 가지고있는 비공식 버전 관리 시스템을 보았고 최신 개정판이 "아카이브"와 동일한 폴더 레벨에있는 해당 폴더에 파일의 과거 개정판을 넣었습니다.


우리의 'wiki'솔루션은 네트워크 공유에 대한 링크 또는 네트워크의 파일에 직접 링크됩니다. 버전 제어가 없다는 단점이 있습니다. 또는 파일을 위키에 다운로드 / 편집 / 업로드합니다. 오타를 수정하기 위해 편집 할 때마다 10 단계 처리
David

더 많은 무료 쉐어 포인트 대안 (더 나은 방법!) : Nuxeo를 사용하여 간단하게 설정하십시오. 또는 필요하다면 더 많은 힘을 가진 무언가를위한 Alfresco.
gbjbaanb

컴퓨터에 설치된 Google 검색은 물건을 찾는 것이 좋습니다.

3

회사에서 가장 잘 해결 된 솔루션은 위키를 설정하는 것이 었습니다 (미디어 위키 사용). 전통적인 위키 항목부터 간단한 "This is a ..."및 Word 문서에 이르기까지 여러 가지 방법으로 사용됩니다. 검색이 매우 쉽습니다. 우리는 점차 매우 유용한 정보 저장소를 구축하고 있습니다.


우리는 doku-wiki를 사용하려고 시도했지만 사용하는 것은 매우 지루합니다 (doc typo라는 단어를 수정하는 것은 지루한 10 단계입니다). 또한 파일 크기와 파일 확장자에 대한 많은 경고와 제한 사항이 실제로 도움이되는 것 이상으로 귀찮았습니다. 나는 회사의 다른 사람들로부터 그것을 사용하는 것에 대한 구매를 얻지 못했습니다. 나는 큰 잠재력을 볼 수 있지만 불행히도 우리 회사에게는 그렇지 않습니다.
David

1

VS 2008에서는 적어도 C ++ 프로젝트의 구성 유형 (프로젝트 속성-> 일반-> 프로젝트 기본값)을 Utility로 설정할 수 있습니다 . 이 경우 VS는 아무것도하지 않습니다.

C # 기반 솔루션에서 이러한 프로젝트를 사용해 보셨습니까? (C # 프로젝트와 비슷한 것이 있습니까?)


0

나는 여기에 가장 좋은 단일 솔루션이 없다는 데 동의합니다. 그러나 버전 관리! = 솔루션에 포함되어 있습니다. 대부분의 시스템은 IDE 이외의 것을 처리 할 수 ​​있습니다. 따라서 대부분의 경우 문서를 닫아 둘 수는 있습니다.

이제 파일을 열 때마다 파일을 변경하기 위해 성가신 단어 습관을 겪는 것은 다른 문제입니다. . .


0

아니요, Visual Studio (well, C # 및 Vb.net) 프로젝트에는 솔루션 탐색기에 대한 두뇌 접근 방식이 있습니다. VC ++ 파일은 디스크 레이아웃에 묶이지 않은 가상 폴더를 만들고 모든 종류의 항목을 저장할 수 있으므로 훨씬 좋습니다. Silly Microsoft는 '더 이해하기 쉽게'만들려고 노력하여 실패했습니다.

여전히 '솔루션 폴더'에 넣을 수는 있지만 원하는만큼 유연하지는 않습니다. 즉, 대안을 찾아야하며 권장하는 대안은 웹 도구입니다. 당신이 문서를 저장할 수있는 (예 : 레드 마인과 같은) 프로젝트 포털을 시도하지 않으려는 경우 , 등 등을 위키, 버그 추적기를 다음 문서 관리 도구를 이동합니다. Nuxeo 또는 Owl과 같은 것이 당신을 잘 할 것입니다. 일단 웹이되면 중앙에 위치하여 사람들이 이러한 것을 찾을 위치를 알 수 있습니다. 이는 아마도 문서 관리에서 가장 중요한 부분 일 것입니다. subversion과 같은 버전 제어 시스템에 연결하면 (VSS 이후에는 후회하지 않을 것입니다!) 문서를 웹 도구에 연결하고 버전을 제어 할 수 있습니다.

Subversion은 리포지토리를 webdav 폴더, 즉 네트워크 폴더로 표시하는 기능도 제공하므로 youcoudl은 '네트워크 드라이브'에 배치하지만 여전히 자동으로 버전을 제어 할 수 있습니다.

저는 여전히 개인적 선호로 Redmine을 선택했습니다.

당사 사이트를 사용함과 동시에 당사의 쿠키 정책개인정보 보호정책을 읽고 이해하였음을 인정하는 것으로 간주합니다.
Licensed under cc by-sa 3.0 with attribution required.