프로젝트 문서, 사양을 구성하고 유지 관리하는 소프트웨어? [닫은]


15

프로젝트 내부 문서, 사양, 요구 사항 등을 구성하고 유지 관리하는 소프트웨어를 찾고 있습니다. 현재 모든 문서를 많은 MS Word DOC 파일로 소스 제어 리포지토리에 저장하므로 버전을 제어 할 수 있습니다. 그러나이 정보를 검색하고 정보를 연결하거나 분류하고 공동 작업 할 수는 없습니다.

요구 사항, 환경 설정 :

  • 클라이언트 측에 제로 설치 (WEB 기반).
  • 문서 버전 관리.
  • 문서 주석.
  • 문서 연결.
  • 전체 검색 (모든 문서).
  • MS Word (*. doc) 가져 오기 \ 내보내기.
  • WYSIWYG 텍스트 편집기.

내가 지금까지 발견하고 시도한 시스템 :


어떤 종류의 프로젝트 문서화 (텍스트, 그래픽, UML 다이어그램, 시간표, 텍스트 사양, 사용자 스토리 등)가 있습니까? 얼마나 많은 사람들이 그것을 유지해야합니까? 소스 코드의 특정 버전 / 개정과 동기화되어야합니까?
Doc Brown

@DocBrown, 95 % 텍스트, 3-5 명이 작성합니다. 소프트웨어 제품 버전과 동기화되어 있지만 소스 코드 개정은 아닙니다.
Alex Burtsev

XWiki는 무료로 제공되는 훌륭한 솔루션처럼 보이며 MS Office와 잘 통합되어 있습니다.
Alex Burtsev

1
이것은 기술 문서를 작성하는 데 어떤 프로그램을 사용합니까? 많은 답변이 비슷하지만 그러한 문서에 위키를 사용하는 것에 대한 더 나은 주장이 있습니다.
Mark Booth

PHPKB 와 같은 지식 관리 소프트웨어는 어떻습니까? 무료는 아니지만 귀하의 목적을 잘 충족시키는 것 같습니다.
Anirudh Srivastava

답변:


6

스핑크스 같은 건 어때?

문서를 reStructuredText (구문은 스택 오버플로에서 사용하는 Markdown과 유사)에 일반 텍스트 파일 (= 버전 관리가 용이함)로 작성하고 Sphinx는 HTML 페이지를 뱉어냅니다.

내가 아는 가장 유명한 두 명의 스핑크스 사용자는 Python 언어TortoiseHG입니다 (스핑크스가 생성 한 문서에 대한 링크 참조).


편집하다:

최종 사용자 문서가 아니라 프로젝트 내부 문서에 대해 이야기하고 있다는 것을 읽었습니다.
제 생각에는 스핑크스와 같은 것이 내부 문서를 작성하는 가장 좋은 방법입니다 (분석가가 reStructuredText를 작성할 수 있도록 제공 한 경우).

  1. 문서의 버전을 쉽게 제어 할 수 있습니다 (그리고 텍스트 파일의 수는 .doc 또는 .pdf와 같은 이진 파일보다 훨씬 적은 공간을 차지합니다).
  2. 개발자가 읽기 쉬운 .doc 또는 .pdf 파일을 원한다면 소스에서 Sphinx로 파일을 만들 수 있습니다.

Sphinx가 너무 복잡한 경우 더 쉬운 방법이 있습니다. Markdown에서 문서 를 작성 하고 Pandoc 을 사용하여 .rtf, .doc 또는 .pdf 파일을 만들 수 있습니다 (더 많은 작업을 수행 할 수 있음).
Pandoc은 Sphinx보다 시작하기가 쉽지만 Pandoc은 Sphinx와 같은 멋진 메뉴 계층을 만들 수 없습니다 (위의 Python 및 TortoiseHG 문서와 같이).

사용하는 도구에 관계없이 내부 웹 서버와 빌드 서버가있는 경우 누군가가 문서에 무언가를 푸시 할 때마다 빌드 서버가 HTML 출력을 생성하고이를 웹 서버에 복사하도록이를 설정할 수 있습니다. 따라서 분석가는 최종 결과에 대해 생각할 필요가 없으며 변경 사항을 커밋하고 푸시하기 만하면됩니다.


HTML을 생성하는 것 같습니다. 그러면 웹 서버에이를 게시해야합니다
Alex Burtsev

1
@AlexBurtsev : 공개하고 싶다면 예. 반면에-이제 Word .doc 파일을 사용하고 있으므로 공개하려면 웹 서버에도 파일을 넣어야합니다.
Christian Specht

Sphinx에는 "PDF로 출력"경로가 있습니다.
Robert Harvey

@ChristianSpecht, Wiki 및 Wordpress에는 Word Doc 파일을 가져 오는 플러그인이 있습니다.
Alex Burtsev

@ AlexBurtsev : 문서로 무엇을하고 싶은지 잘 모르겠습니다. 웹에 넣으려면 Sphinx, Wordpress, .doc 다운로드 등을 사용하더라도 웹 서버가 필요합니다. 수축 포장 소프트웨어와 함께 설명서를 배포해야하는 경우 Sphinx를 사용하여 PDF 또는 Windows 도움말 파일을 생성 할 수 있습니다.
Christian Specht

5

글쎄, 당신은 Wiki를 구현하려고 할 수 있습니다. Mediawiki는 당신이 말하고있는 모든 누락 된 기능 (검색 기능, 버전 기록, 링크, 분류)을 가지고 있습니다. 어떤 버전의 문서가 어떤 버전의 소프트웨어에 속하는지 정확하게 알고 있어야하지만 각 버전 종속 기사에 버전 참조 또는 특정 범주를 포함시키는 규칙에 따라 수행 할 수 있습니다.

그러나 당신은 개발자가 아닌 "분석가"를 가지고 있습니다 (나는 그 별자리의 팬이 아니라는 것을 인정합니다). 이러한 종류의 사람들은 MS Office 도구를 Wiki와 같은 텍스트 중심 도구로 대체 할 때 종종 만족하지 않습니다. 그리고 MS-Word는 자유 소프트웨어가 아니기 때문에 "자유 소프트웨어"라는 요구 사항이 꼭 필요한 것은 아닙니다. 이 상황에서는 Sharepoint 서버가 더 나은 대안 일 수 있습니다. 무료는 아니지만 AFAIK에는 요청한 모든 기능이 있으며 Word, Excel 등을 사용하여 문서를 계속 만들 수 있습니다.


1
우리는 이미 SharePoint 서버를 가지고 있지만 개발자는 그것을 좋아하지 않으며 사용하고 싶지 않습니다 (저는 개발자 본인입니다). 우리는 필요한 정보를 쉽게 찾을 수있는 것을 원합니다. 분류 및 링크 된 정보.
Alex Burtsev

@AlexBurtsev : Sharepoint 서버를 직접 사용한 적이 없지만 Sharepoint가 설명하는 모든 기능을 제공한다는 인상을 받았습니다. 그러나 Wiki를 선호한다면 Mediawiki가 좋습니다. 그러나 설치, 구조 개요 정의 및 사용 / 사용하지 않는 방법에 대한 규칙을 정의하기 위해 초기 노력을 기울일 것입니다.
Doc Brown

저는 현재 MS Office 통합을 위해 XWiki를 시험하고 있습니다
Alex Burtsev

@DocBrown-SharePoint는 끔찍합니다. 직관적이지 않은 탭과 하위 탭의 미로이며 적절한 버전 제어를 유지하지 않습니다. 그것을 사용하는 사람은 모든 문서를 내부 서버의 공유 디렉토리에 덤프하는 것이 좋습니다. 위키는 보통 이런 종류의 일을하는 길입니다.
다항식

2

학습 곡선이 약간 가파르지만 사양과 문서를 버전 관리 상태로 유지하는 것이 가장 좋습니다. 지식 엔진의 경우 다음을 권장합니다

  1. Trac- 사용하기 쉬운 버그 추적 시스템 및 지식 엔진. 파이썬으로 작성되고 확장 가능하면 몇 분 안에 시작될 수 있습니다.
  2. MoinMoin- 본격적인 위키 엔진. 많은 기능을 가진 다시 파이썬

둘 다 최소한의 인터페이스를 가지고 있으며, 대부분의 위키 구조를 지원하며, 배포 및 유지 관리가 쉽고, 수정을 지원하며, WYSIWYG 편집기가 우수하며 문서 및 사양도 유지할 수 있습니다. 프로젝트가 엄청나게 크지 않다면, 위의 방법 중 하나를 선택할 수 있습니다.


2

우리는 최근 에 많은 흥미로운 특성을 가진 Alfresco DMS를 사용하기 시작했습니다 .

  • 매우 간단한 설치
  • 문서 더미를 빠르게 검색 할 수있는 내장 인덱서가 있습니다.
  • 워크 플로우, 그룹 및 필요한 경우 고객의 문서에 대한 특정 액세스를 허용합니다
  • 오픈 소스
  • 활동적인 커뮤니티
  • LDAP / AD / SSO 통합
  • 다양한 문서 처리

단점도 있습니다 :

  • 사용자 인터페이스가 항상 직관적 인 것은 아닙니다
  • 실제로 위키가 아니므로 한 문서에 대한 동시 협업 작업은 약간 깨지기 쉽습니다.

당신이 스윙을하기로 결정하면, 의견을 저에게 연락 주시기 바랍니다.


0

또 다른 가능성은 사용할 수 있습니다 유액 또는 다른 텍스트 포맷터 (아마 인 texinfo 또는 무지 렁 문서에 대한 참조). 그것의 일부는 기계 생성 될 수 있습니다. LaVeX 를 HTML로 변환하는 HeVeA 와 같은 HTML 변환 도구가 있습니다 . doxygen 을 사용 하여 소스 코드 내의 구조화 된 주석에서 문서를 생성 할 수도 있습니다 . 문서의 손으로 쓴 부분은 소스 코드 (egwrt 버전 제어 및 빌드)로 관리 할 수 ​​있습니다.


소프트웨어 제품 설명서 (도움말, 설명서)에 대해서는 이야기하지 않습니다. 소프트웨어 사양, 비즈니스 요구 사항에 대해 이야기하고 있습니다.
Alex Burtsev

LaTeX에서 소프트웨어 사양 또는 기술 문서를 작성할 수 있으며 일부 서클에서는 일반적입니다.
Basile Starynkevitch

2
LaText는 어떻게 든 * NIX를 상기시켜 주며, 우리 분석가는 그러한 OS를 절대로 모으지 않으며 Windows 세계에 살고 있으며 텍스트 입력을 위해 Word보다 어려운 것에 동의하지 않습니다.
Alex Burtsev

-2

문서 외에도 UML 및 ERD 도구를 사용하는 것이 좋습니다. 또한 ZOHO-Docs의 ZOHO에 이러한 문서를 저장할 수 있습니다. 무료는 아니지만 매우 저렴하며 문서 검색 기능을 제공합니다.

어떤 도구를 사용하든 텍스트 검색을 사용하고 의미있는 결과를 얻을 수 있도록 문서 내용을 신중하게 구성해야합니다. 영리하고 표준적인 파일 이름 지정과 함께 문서 컨텐츠 구성이 크게 도움이 될 수 있습니다.

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