หน้านี้มีรายละเอียดของโครงการการเขียนเชิงเทคนิคที่ยอมรับสำหรับ Google Season of Docs
ข้อมูลสรุปของโปรเจ็กต์
- องค์กรโอเพนซอร์ส:
- มูลนิธิ Linux
- ผู้เขียนด้านเทคนิค:
- เซียวยา
- ชื่อโปรเจ็กต์:
- จัดทำเอกสารประกอบสำหรับโปรเจ็กต์ป้าย CHAOSS D&I
- ระยะเวลาของโปรเจ็กต์:
- ระยะเวลามาตรฐาน (3 เดือน)
คำอธิบายโปรเจ็กต์
ฉันใส่เนื้อหาหลักไว้ดังนี้ เป้าหมายหลักคือทำให้งานที่เกี่ยวข้องกับเอกสารมีความสมบูรณ์มากขึ้นในเวิร์กโฟลว์ เขียนเอกสารประกอบการติดป้าย D&I ที่ชุมชนมอบหมาย และโฮสต์เอกสารที่ประมวลผลแล้วหลายภาษาในแพลตฟอร์มเฉพาะทาง ซึ่งสามารถแยกออกเป็นงานย่อยๆ ได้ ดังนี้ อัปเดตและผสานรวมเทมเพลตการประชาสัมพันธ์ปัจจุบันเพื่อใช้เมตริก D&I เพิ่มเติมและตอบคำถามที่หลากหลาย ร่างภาพรวมแนวคิดเพื่อแนะนำโปรแกรมการติดป้าย D&I ร่างหลักเกณฑ์ของผู้นำไปใช้โดยใช้เอกสาร JOSS เป็นข้อมูลอ้างอิง ร่างหลักเกณฑ์ของผู้ตรวจสอบโดยใช้เอกสาร JOSS เป็นข้อมูลอ้างอิง เอกสารที่อธิบายบทบาทต่างๆ และความรับผิดชอบที่เกี่ยวข้องตลอดเวิร์กโฟลว์ เอกสารที่อธิบายวิธีการนำ GitHub Probot ไปใช้ในเวิร์กโฟลว์ หลักเกณฑ์สำหรับ Contributor เพื่อแสดงว่าผู้ใช้ใหม่ร่วมสนับสนุนโปรเจ็กต์หรือเอกสารได้อย่างไร ช่วยเรื่องงานแปลเอกสาร ตรวจสอบประสิทธิภาพของการแปลอัตโนมัติโดยเฉพาะภาษาจีน และแปลด้วยตนเองหากจำเป็น จัดระเบียบเอกสารในรูปแบบหลายภาษาตามงานแปล ใช้ Gitbook, อ่านเอกสาร หรือ GitHub Wiki เพื่อโฮสต์เอกสาร
การส่งมอบ 1. ทำให้เทมเพลต PR สำหรับโครงการและกิจกรรมสมบูรณ์ยิ่งขึ้นด้วยเมตริกและคำถามที่หลากหลายมากขึ้น สิ่งที่ส่งมอบนี้รวมถึงงานทั้งหมดที่เกี่ยวข้องกับเอกสารภายในเวิร์กโฟลว์ โดยเฉพาะเทมเพลต PR ที่เตรียมไว้ให้ผู้สมัครกรอกข้อมูล นี่เป็นสิ่งที่ฉันคิดว่าเป็นองค์ประกอบสำคัญของเวิร์กโฟลว์เนื่องจากมีบทบาทหลักในการประเมินของผู้ตรวจสอบ ดังนั้นแบบฟอร์มและเนื้อหาของคำถามจะสมบูรณ์แบบตลอดกระบวนการทำงาน และฉันจะนำเสนอประเด็นต่างๆ ที่ต้องใช้คำถามต่อไปนี้ด้วยการตั้งฐานของคำถามหรือโครงการประเภทต่างๆ ผสมผสานกับคำถามหรือโครงการประเภทต่างๆ
ส่งมอบได้ 2. ด้านล่างนี้คือฉบับร่างเอกสารที่แสดงจากชุมชน
ภาพรวมของป้าย D&I
บทนำ
เป้าหมาย
รักษาระดับป้าย
การขอรับป้าย
สมัครรับป้ายกิจกรรม
เทมเพลตประชาสัมพันธ์กิจกรรม
สมัครรับป้ายโครงการ
เทมเพลต PR ของโครงการ
การตรวจสอบ
วิธีการเป็นผู้ตรวจสอบ
ป้าย D&I การตรวจสอบ
ป้าย D&I การตรวจสอบความขัดแย้งของเจ้าหน้าที่ตรวจสอบ
ตรวจสอบบทบาทและหน้าที่ของเจ้าหน้าที่ตรวจสอบ
ตรวจสอบบทบาทและหน้าที่ของเจ้าหน้าที่ตรวจสอบ
ตรวจสอบบทบาทและหน้าที่ของฝ่ายประชาสัมพันธ์
ส่งมอบได้ 3. จัดระเบียบเอกสารในรูปแบบหลายภาษาและโฮสต์เอกสารในแพลตฟอร์มต่างๆ เช่น อ่านเอกสารหรือ Gitbook
ในเวิร์กโฟลว์ปัจจุบัน มีการสำรวจงานแปลอัตโนมัติบางงาน ฉันจะช่วยตรวจสอบว่าผลลัพธ์ของการแปลนั้นมีประสิทธิภาพเพียงใดโดยเฉพาะในภาษาจีน เช่น ความถูกต้องและความคล่องในการแปล เอกสารนี้จะอยู่ในรูปแบบหนึ่ง ผมจะตรวจสอบแพลตฟอร์มโฮสติ้งเอกสารทางเทคนิค เช่น อ่านเอกสาร, Gitbook และ GitHub wiki แล้วเลือกแพลตฟอร์มที่เหมาะสมที่สุดในการโฮสต์เอกสารเปิดจากชุมชน