툴링에 대한 주석.
우리는 온라인 위키를 시험해 보았지만 개인적인 취향이지만 문서 구조와 문서 서버에 가장 중요하게 연결되어야하는 많은 제한 사항을 발견했습니다.
오프라인이거나 현장에있는 경우 연결되는 것은 심각한 문제입니다 (확실히 SSL 연결 등으로 현장을 완화 할 수 있음).
현재 문서화 프로세스는 다음과 같습니다.
- 정적 HTML 생성기
- 마크 다운 구문
- 분산 버전 관리 시스템
우리는 문서를위한 '형식적인'레이아웃을 가지고 있으며 메뉴의 구조 (및 비주얼 스타일링을위한 관련 CSS)를 제공합니다.
정적 HTML 생성기
우리는 기반으로 집에 정적 HTML 생성기 사용 cubictemp : 및 기타 도구의 숫자 pygments , docutils을 .
우리 / 우리의 시스템 관리자 / 프로그래머 대부분은 미적으로 아름답지만 그러한 건축에 대한 조정이 전혀 없기 때문에 생성 된 페이지는 분명하지 않습니다.
그러나 HTML 파일 형식을 망칠 걱정이나 다운로드를 위해 '서버'에서 찾을 위치에 대해 걱정할 필요없이 구성 파일, 샘플 스크립트, pdf 등을 포함시킬 수 있습니다.
HTML이 아닌 경우 폴더에 드롭하고 URL 링크를 추가하십시오.
HTML은 레이아웃을위한 '잠재적'구조를 제공하고, 지식 / 컨텐츠 항목 (메뉴, 컨텐츠 테이블 등을 만들 수있는 것과 같은 기본 구조 메커니즘) 사이의 '링크'를 비판적으로 제공합니다. HTML을 사용하면 각 사용자는 이제 lighttpd이든 작든 아파치 나 IIS로 가득 찬 작은 웹 서버를 컴퓨터에서 실행하십시오.
우리의 모든 기계에는 기본 HTML 서빙에 대한 불만이 있으며 우리에게 충분히 잘 작동합니다.
MARKDOWN 구문.
우리는 MARKDOWN, Textish 및 reStructuredTEXT 의 나쁜 버전을 사용하여 '크리에이티브'주스가 HTML에 대해 걱정할 필요없이 문서를 작성할 수 있도록합니다.
또한 모든 사람들이 자신이 좋아하는 편집기 (Windows 및 * Nix에서는 Scintilla를 사용함)를 사용하고 다른 사람들은 vi / vim을 사용합니다.
분산 버전 관리 시스템.
우리는 Git 을 사용 하여 사용자간에 문서를 '배포'합니다. 아, 우리는 그것도 버전 관리 용량을 사용합니다.
우리에게 가장 큰 장점은 서버에 연결하지 않고도 '완료된'저작물을 게시하지 않고도 문서를 업데이트 할 수 있다는 것입니다. 우리는 모두 문서의 동일한 부분이나 다른 부분에서 작업하거나 정보를 사용할 수 있습니다.
개인적으로, 나는 Wiki는 물론 블로그를 업데이트하기 위해 서버에 묶인 것을 싫어합니다. 힘내는 우리를 위해 잘 작동합니다.
워크 플로우에 대한 주석
Wiki는 지식 보급 / 목록 화를위한 "패션"으로 보이지만 다른 곳에서는 모든 프로세스를 유지하기가 어려워지고 팀의 요구를 가장 잘 지원하고 지속 가능한 도구 조합을 찾는 데 시간이 걸립니다.
더 나은 솔루션은 발견되고 의무화되지 않습니다.