이 페이지에는 Google Season of Docs에 선정된 기술 문서 프로젝트의 세부정보가 포함되어 있습니다.
프로젝트 요약
- 오픈소스 조직:
- Tor 프로젝트
- 기술 문서 작성자:
- 스와티 탁커
- 프로젝트 이름:
- Tor 매뉴얼 페이지 재작성
- 프로젝트 길이:
- 장기 실행 (5개월)
Project description
TOR 멘토와 논의하여 이 프로젝트에 대한 기대치를 파악한 후 TOR 매뉴얼 페이지 (https://2019.www.torproject.org/docs/tor-manual.html.en)를 사용자에게 유용한 빠른 참조 자료로 만들기 위해 일관된 구조와 형식을 설정하기 위한 다음 아이디어를 제안합니다. 이 프로젝트는 3개월 이내에 완료되며 다음 아이디어는 월별로 분류됩니다.
1개월 차:
이 페이지의 목차를 만듭니다. TOC에는 개요 주제와 9개의 구성 옵션 카테고리 전체의 제목이 포함됩니다. 이달 말이 되면 사용자는 다양한 구성 카테고리로 손쉽게 이동할 수 있게 됩니다. TOC는 다음과 같습니다.
- 개요 – TOR가 이러한 다양한 옵션 카테고리의 구성을 유지하는 위치(모두 한 번에 한 위치에 있는 경우), 구성 파일의 이름 및 기본 위치, 명령어 옵션을 사용하는 규칙, 사용자가 이러한 옵션을 수정하는 방법에 관한 정보를 추가합니다. 구성 파일 형식 주제의 시작 문구에 있는 정보를 포함할 수 있습니다.
- 일반 옵션
- 클라이언트 옵션
- 서버 옵션
- 디렉터리 서버 옵션
- 네트워크 옵션 테스트
- 서비스 거부 완화 옵션
- Directory Authority Server 옵션
- 숨겨진 서비스 옵션
- 비지속적 옵션
2개월 차:
매뉴얼 페이지의 목적은 각 옵션의 작동 방식과 기능에 관한 질문에 빠르게 답변하는 것입니다. 현재 옵션은 구조화된 형식으로 문서화되어 있지 않으며 각 옵션에 관한 정보가 단락으로 표시되어 한눈에 정보를 찾기 어렵습니다. 옵션에 관한 기존의 모든 정보를 템플릿을 사용하여 재구성해야 합니다. 이번 달 말까지 기존 옵션과 향후 제공될 새로운 옵션을 문서화하는 일관된 형식이 마련될 예정입니다. 또한 이 형식을 사용하면 향후 TOR 매뉴얼을 'man' 페이지로 쉽게 사용할 수 있습니다.
- 먼저 서버 옵션, 클라이언트 옵션 등 각 옵션 카테고리에 관한 간단한 설명을 추가합니다. 설명을 통해 사용자는 각 카테고리에서 어떤 옵션을 기대할 수 있는지 알 수 있습니다.
- 각 옵션을 문서화하기 위한 일관된 형식을 정의하는 템플릿을 만듭니다. 다음 섹션/하위 섹션을 템플릿에 포함할 것을 제안합니다.
- 이름: 문서화되는 옵션의 이름입니다. 예: BandwidthBurst
- 개요: 옵션의 명령줄 문법이 어떻게 표시되는지에 관한 요약입니다. 예: BandwidthBurst N바이트
- 설명: 구성 옵션의 기능과 기본값을 설명합니다. 예: 이 옵션을 사용하여 버스트라고도 하는 최대 토큰 버킷 크기를 각 방향의 지정된 바이트 수로 제한합니다. 이 옵션의 기본값은 1GB입니다.
- 옵션 값: 옵션에서 허용하는 값을 나열하고 설명합니다. 각 값의 기능과 사용자가 값을 입력하는 방법을 자세히 설명합니다.
3개월 차:
현재 구성 옵션에는 9개의 그룹/카테고리가 있습니다. 검색 가능성을 높이고 빠르게 참조할 수 있도록 9개의 각 카테고리 내에서 알파벳순으로 정렬된 구성 옵션을 나열하는 색인 페이지를 만드세요. 그런 다음 이러한 카테고리를 사용 빈도에 따라 정렬할 수 있으며 가장 일반적으로 사용되는 옵션 카테고리가 맨 위에 표시됩니다.
3개월이 지나면 사용자가 TOR에서 구성 설정을 수정할 때 빠른 참조로 사용할 수 있는 TOR 매뉴얼을 업데이트할 수 있습니다.