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