หน้านี้มีรายละเอียดของโครงการเขียนเชิงเทคนิคที่ยอมรับใน Google Season of Docs
ข้อมูลสรุปของโปรเจ็กต์
- องค์กรโอเพนซอร์ส:
- โปรเจ็กต์ Tor
- ผู้เขียนด้านเทคนิค:
- สวาติ Thacker
- ชื่อโปรเจ็กต์:
- เขียนหน้า Tor ด้วยตนเองใหม่
- ระยะเวลาของโปรเจ็กต์:
- ระยะยาว (5 เดือน)
คำอธิบายโปรเจ็กต์
หลังจากพูดคุยกับที่ปรึกษา TOR เพื่อทำความเข้าใจความคาดหวังจากโปรเจ็กต์นี้แล้ว ฉันขอเสนอแนวคิดต่อไปนี้เพื่อกำหนดโครงสร้างและรูปแบบที่สอดคล้องกันสำหรับหน้า TOR Manual (https://2019.www.torproject.org/docs/tor-manual.html.en) เพื่อเปลี่ยนให้เป็นข้อมูลอ้างอิงที่กระชับและเป็นประโยชน์สำหรับผู้ใช้ โปรเจ็กต์นี้จะเสร็จสมบูรณ์ใน 3 เดือน และแนวคิดต่างๆ ต่อไปนี้จะแจกแจงตามเดือน
เดือน 1:
สร้างสารบัญสำหรับหน้านี้ TOC จะประกอบด้วยหัวข้อภาพรวม และส่วนหัวของตัวเลือกการกำหนดค่าทั้ง 9 หมวดหมู่ ภายในสิ้นเดือนนี้ ผู้ใช้จะไปยังหมวดหมู่การกำหนดค่าต่างๆ ได้ด้วยปลายนิ้ว ซึ่ง TOC จะมีลักษณะดังนี้
- ภาพรวม – เพิ่มข้อมูลเกี่ยวกับตำแหน่งที่ TOR ดูแลการกำหนดค่าสำหรับหมวดหมู่ตัวเลือกต่างๆ เหล่านี้ หากทั้งหมดอยู่ในที่เดียว ชื่อและตำแหน่งเริ่มต้นของไฟล์การกำหนดค่า กฎในการใช้ตัวเลือกคำสั่ง และผู้ใช้จะแก้ไขตัวเลือกเหล่านี้ได้อย่างไร (เราสามารถรวมข้อมูลจากข้อความแนะนำภายใต้หัวข้อรูปแบบไฟล์การกำหนดค่า)
- ตัวเลือกทั่วไป
- ตัวเลือกไคลเอ็นต์
- ตัวเลือกเซิร์ฟเวอร์
- ตัวเลือกไดเรกทอรีเซิร์ฟเวอร์
- การทดสอบตัวเลือกเครือข่าย
- ตัวเลือกการปฏิเสธการให้บริการ
- ตัวเลือกเซิร์ฟเวอร์ผู้ออกใบรับรอง
- ตัวเลือกบริการที่ซ่อนอยู่
- ตัวเลือกที่ไม่ถาวร
เดือน 2:
หน้าที่ของหน้าที่ป้อนด้วยตนเองจะต้องตอบคำถามอย่างรวดเร็วว่าตัวเลือกแต่ละรายการทำอะไรได้บ้างและอย่างไร ปัจจุบันตัวเลือกต่างๆ ไม่ได้ถูกบันทึกในรูปแบบที่มีโครงสร้าง และข้อมูลเกี่ยวกับแต่ละตัวเลือกจะแสดงเป็นย่อหน้า ซึ่งทำให้การค้นหาข้อมูลโดยย่อเป็นเรื่องยาก ข้อมูลที่มีอยู่ทั้งหมดเกี่ยวกับตัวเลือกต้องจัดระเบียบใหม่โดยใช้เทมเพลต ภายในสิ้นเดือนนี้ เราจะมีรูปแบบที่สอดคล้องกันสำหรับการบันทึกตัวเลือกที่มีอยู่และตัวเลือกใหม่ใดๆ ในอนาคต นอกจากนี้ รูปแบบนี้จะช่วยให้สามารถใช้คู่มือ TOR เป็นหน้าสำหรับ "มนุษย์" ได้ง่ายในอนาคต
- ขั้นแรก เพิ่มคำอธิบายสั้นๆ เกี่ยวกับหมวดหมู่ตัวเลือกแต่ละหมวด เช่น ตัวเลือกเซิร์ฟเวอร์ ตัวเลือกไคลเอ็นต์ และอื่นๆ คำอธิบายช่วยให้ผู้ใช้ทราบว่าควรคาดหวังตัวเลือกใดในแต่ละหมวดหมู่
- สร้างเทมเพลตเพื่อกำหนดรูปแบบที่สอดคล้องกันสำหรับการบันทึกตัวเลือกแต่ละรายการ ฉันเสนอให้รวมส่วน/ส่วนย่อยต่อไปนี้ไว้ในเทมเพลต
- ชื่อ: ชื่อของตัวเลือกที่มีการลงเอกสารประกอบ ตัวอย่าง: BandwidthBurst
- เรื่องย่อ: สรุปลักษณะของตัวเลือกโดยใช้ไวยากรณ์บรรทัดคำสั่ง ตัวอย่าง: BandwidthBurst N ไบต์
- คำอธิบาย: อธิบายว่าตัวเลือกการกำหนดค่าทำอะไรได้บ้างและค่าเริ่มต้นคืออะไร ตัวอย่าง: ใช้ตัวเลือกนี้เพื่อจำกัดขนาดที่เก็บข้อมูลโทเค็นสูงสุด หรือเรียกว่า Busrt ให้กับจำนวนไบต์ที่ระบุในแต่ละทิศทาง ตัวเลือกนี้มีค่าเริ่มต้นเป็น 1 GB
- ค่าตัวเลือก: แสดงและอธิบายค่าที่ตัวเลือกอนุญาต อธิบายโดยละเอียดว่าแต่ละค่าทำหน้าที่อะไรและผู้ใช้ควรป้อนค่าอย่างไร
เดือน 3:
ขณะนี้ตัวเลือกการกำหนดค่ามี 9 กลุ่ม/หมวดหมู่ เพื่อปรับปรุงความสามารถในการค้นหาและเป็นข้อมูลอ้างอิงอย่างรวดเร็ว ให้สร้างหน้าดัชนีที่แสดงตัวเลือกการกำหนดค่าที่จัดเรียงตามตัวอักษรของแต่ละหมวดหมู่ 9 หมวดหมู่ จากนั้น หมวดหมู่เหล่านี้จะเรียงลำดับตามลำดับความสำคัญของการใช้งาน ซึ่งเป็นหมวดหมู่ตัวเลือกที่ใช้กันมากที่สุดซึ่งจะอยู่ด้านบนสุด
เมื่อสิ้นสุด 3 เดือน เราจะจัดทำคู่มือ TOR ที่ซ่อมแซมใหม่เพื่อให้ผู้ใช้ใช้เป็นข้อมูลอ้างอิงโดยย่อเพื่อแก้ไขการตั้งค่าการกําหนดค่าใน TOR