어떤 종류의 온라인 기술 문서 시스템을 추천 하시겠습니까? [닫은]


11

목표는 다음과 같은 주요 요구 사항을 갖춘 온라인 문서 시스템을 갖추는 것입니다.

  • 는 주로 모든 응용 프로그램의 최종 기술 문서에 대한 중간 단계로 사용됩니다 (아마도 절대로 완료되지는 않습니다 :]). 일반적으로 다음과 같이 사용됩니다. 누군가 문제가 있고 수정 한 후 수정 사항을 즉시 기록해 둡니다. 지금 일어나고있는 일은 관리 할 수없는 상태가되었습니다. 누군가 문제가 있습니다. 문제를 해결했습니다. 저와 누군가는 행복하지만 2 개월 후에는 다른 사람이 같은 문제를 겪고 있으며 수정 사항을 기억하지 않습니다.
  • 아파치 서버 뒤에서 실행하여 어디서나 액세스 가능
  • 읽기 전용 / 읽기 / 쓰기 / 관리자 액세스를 허용하는 사용자 / 그룹 관리
  • 형식은 그렇게 중요하지 않습니다 : 일반 텍스트는 할 것이고 위키 스타일은 더 좋을 것입니다
  • 싸거나 무료

내 아이디어 :

  • 파일 공유 또는 ssh를 통해 파일을 제공하기 만하면됩니다 (단점 : Windows와 너무 호환되지 않음, 전문가 : 단순, 모든 파일 형식 일 수 있음)
  • SCM에 보관하십시오 (svn / git, 위와 같지만 액세스 및 액세스 제어가 쉬움)
  • 합류 : 우리는 이미 Jira를 사용하고 있습니다. 합류는 그만한 가치가 있습니까? Jira와 어떻게 통합됩니까?
  • 다른 것?

이에 대해 의견을 주거나 다른 시스템과 경험을 공유하십시오.


문서가 코드 (예 : Javadocs)로 생성되거나 처음부터, 사용자 안내서 또는이 둘의 조합으로 작성되고 있습니까?
FrustratedWithFormsDesigner

그것은 주로 더 많은 사용자 가이드, 코드가 아닌 문서의이다 (물론, 우리는뿐만 아니라, doxygen에 의해 생성 된, 우리가 그것을 포함 할 수 있음을 가지고 있지만, 그것은 관심의 첫 번째 지점이 아니다)
스테인

나는 현금을 Spolsky에게 넘겨 줄 것입니다.
Job

답변:


11

나는 Wiki를 제안하려고했다

Confluence는 위키이기 때문에 JIRA와 함께 사용하는 것이 좋습니다. JIRA 이슈에 직접 연결될 수있는 장점이 있으므로 실제 코드 / 문서 / 변경 사항 등

이와 같은 코드 문서 저장소의 핵심은 탐색 측면입니다. 연결이 끊어지고 찾기 어려운 페이지는 원하지 않습니다. 웹 사이트에서와 같이 '사이트 레이아웃'에 생각을 넣지 마십시오.


Confluence는 다양한 플랫 형식으로 내보낼 수 있습니다. 가장 쉬운 방법 중 하나와 같은 사운드가 완성 produc.t 쉽게 편집 할 수에서 얻을

2
MediaWiki에서 마이그레이션 한 Confluence는 여러 형식 (Word가 가장 널리 사용되는)으로 출력하는 작업이 훌륭합니다. 그러나 WYSIWYG 편집 도구는 엄청나게 버그가 있으며 태그 시스템은 적어도 우리 설치에서 바람직하지 않습니다.
Philip Regan

Wiki의 경우 +1인데, Trac은 SVN과 통합되어 파일 공유도 가능하므로 매우 유용합니다.

우리는 Confluence 시험을 확인했고 해결책이 될 것입니다. 우리가 필요로하는 것보다 더 많은 것을 할 수있는 것처럼 보이지만, 작업하기는 매우 쉽습니다. 나는 몇 년 전에 Trac을 시험해 보았는데, 특히 플러그인 등에 관해서는 내 취향에 너무 지저분했다.
stijn
당사 사이트를 사용함과 동시에 당사의 쿠키 정책개인정보 보호정책을 읽고 이해하였음을 인정하는 것으로 간주합니다.
Licensed under cc by-sa 3.0 with attribution required.