스핑크스 같은 건 어때?
문서를 reStructuredText (구문은 스택 오버플로에서 사용하는 Markdown과 유사)에 일반 텍스트 파일 (= 버전 관리가 용이함)로 작성하고 Sphinx는 HTML 페이지를 뱉어냅니다.
내가 아는 가장 유명한 두 명의 스핑크스 사용자는 Python 언어 와 TortoiseHG입니다 (스핑크스가 생성 한 문서에 대한 링크 참조).
편집하다:
최종 사용자 문서가 아니라 프로젝트 내부 문서에 대해 이야기하고 있다는 것을 읽었습니다.
제 생각에는 스핑크스와 같은 것이 내부 문서를 작성하는 가장 좋은 방법입니다 (분석가가 reStructuredText를 작성할 수 있도록 제공 한 경우).
- 문서의 버전을 쉽게 제어 할 수 있습니다 (그리고 텍스트 파일의 수는 .doc 또는 .pdf와 같은 이진 파일보다 훨씬 적은 공간을 차지합니다).
- 개발자가 읽기 쉬운 .doc 또는 .pdf 파일을 원한다면 소스에서 Sphinx로 파일을 만들 수 있습니다.
Sphinx가 너무 복잡한 경우 더 쉬운 방법이 있습니다. Markdown에서 문서 를 작성 하고 Pandoc 을 사용하여 .rtf, .doc 또는 .pdf 파일을 만들 수 있습니다 (더 많은 작업을 수행 할 수 있음).
Pandoc은 Sphinx보다 시작하기가 쉽지만 Pandoc은 Sphinx와 같은 멋진 메뉴 계층을 만들 수 없습니다 (위의 Python 및 TortoiseHG 문서와 같이).
사용하는 도구에 관계없이 내부 웹 서버와 빌드 서버가있는 경우 누군가가 문서에 무언가를 푸시 할 때마다 빌드 서버가 HTML 출력을 생성하고이를 웹 서버에 복사하도록이를 설정할 수 있습니다. 따라서 분석가는 최종 결과에 대해 생각할 필요가 없으며 변경 사항을 커밋하고 푸시하기 만하면됩니다.