이 페이지에는 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에서 관리하는 위치, 모두 한 번에 있는 경우, 구성 파일의 이름 및 기본 위치, 명령어 옵션을 사용할 규칙, 사용자가 이러한 옵션을 수정할 수 있는 방법에 대한 정보를 추가합니다. (구성 파일 형식 주제 아래에서 소개 문구에 있는 정보를 포함할 수 있습니다).
- 일반 옵션
- 클라이언트 옵션
- 서버 옵션
- 디렉터리 서버 옵션
- 네트워크 옵션 테스트
- 서비스 거부(DoS) 완화 옵션
- 디렉터리 기관 서버 옵션
- 숨겨진 서비스 옵션
- 비영구 옵션
2개월 차:
매뉴얼 페이지의 목적은 각 옵션의 역할 및 방법에 관한 질문에 신속하게 답변하는 것입니다. 현재 이 옵션은 구조화된 형식으로 문서화되어 있지 않으며 각 옵션에 대한 정보는 한눈에 정보를 찾기 어렵게 만드는 단락으로 표시되어 있습니다. 옵션에 관한 기존 정보는 모두 템플릿을 사용하여 재구성해야 합니다. 이달 말까지 기존 옵션과 향후 새로운 옵션을 문서화하는 일관된 형식을 제공할 예정입니다. 또한 이 형식을 사용하면 TOR 매뉴얼을 향후 'man' 페이지로 쉽게 사용할 수 있습니다.
- 먼저 서버 옵션, 클라이언트 옵션 등 각 옵션 카테고리에 대한 간략한 설명을 추가하세요. 설명은 사용자가 각 카테고리에서 기대할 수 있는 옵션을 파악하는 데 도움이 됩니다.
- 각 옵션을 문서화하기 위한 일관된 형식을 정의하는 템플릿을 만듭니다. 다음 섹션/하위 섹션을 템플릿에 포함할 것을 제안합니다.
- 이름: 문서화되는 옵션의 이름입니다. 예: BandwidthBurst
- 줄거리: 옵션의 명령줄 구문에 대한 요약입니다. 예: BandwidthBurst N 바이트
- 설명: 구성 옵션의 기능과 기본값은 무엇인지 설명합니다. 예: 이 옵션을 사용하여 버스트라고도 하는 최대 토큰 버킷 크기를 각 방향의 지정된 바이트 수로 제한합니다. 이 옵션의 기본값은 1GB입니다.
- 옵션 값: 옵션에서 허용하는 값을 나열하고 설명합니다. 각 값의 역할과 사용자가 값을 입력하는 방법을 자세히 설명합니다.
3개월 차:
현재 구성 옵션에는 9가지 그룹/카테고리가 있습니다. 검색 가능성을 향상하고 빠르게 참조할 수 있도록 9개 카테고리마다 알파벳순으로 정렬된 구성 옵션이 나열된 색인 페이지를 만듭니다. 그런 다음 사용 우선순위에 따라 이 카테고리를 정렬할 수 있으며, 가장 일반적으로 사용되는 옵션 카테고리가 맨 위에 표시됩니다.
3개월이 지나면 사용자가 TOR에서 구성 설정을 수정할 때 빠르게 참조할 수 있는 리퍼 상품 TOR 매뉴얼을 생성할 수 있습니다.