โปรเจ็กต์ Mattermost

หน้านี้มีรายละเอียดของโครงการการเขียนเชิงเทคนิคที่ยอมรับสำหรับ Google Season of Docs

ข้อมูลสรุปของโปรเจ็กต์

องค์กรโอเพนซอร์ส:

สิ่งสำคัญ

ผู้เขียนด้านเทคนิค:

@anindita_basu

ชื่อโปรเจ็กต์:

ตรวจสอบและปรับแต่งข้อความในผลิตภัณฑ์

ระยะเวลาของโปรเจ็กต์:

วิ่งเป็นเวลานาน (5 เดือน)

คำอธิบายโปรเจ็กต์

ผมจึงเข้าร่วมช่อง Slack และตอบคำถามของเอริก อ้างอิงจาก
คำตอบของเขา (ขอบคุณครับ Eric!) ฉันเสนอที่จะเข้าหาโปรเจ็กต์นี้
ในลักษณะต่อไปนี้

1. จำแนกประเภทสตริง

   ฉันจะเริ่มต้นด้วยการระบุว่าสตริงใด (https://github.com/mattermost/mattermost-webapp/blob/master/i18n/en.json) เป็นสตริงของระบบ และสตริงใดบ้างที่แสดงต่อผู้ใช้ เราขอเสนอให้นำสตริงที่แสดงแก่ผู้ใช้ไปตรวจสอบก่อน

2. สร้างคู่มือสไตล์สำหรับสตริง

   ฉันต้องการกำหนดรูปแบบสำหรับการใช้อักษรตัวพิมพ์ใหญ่ ความยาว และการใช้คำสำหรับสตริงที่ใช้ในรายการเมนู ปุ่มการทำงาน ป้ายกำกับ ส่วนหัว เคล็ดลับเครื่องมือ ข้อผิดพลาด คำเตือน การตรวจสอบ การแจ้งเตือน และการยืนยัน (ดูตัวอย่างภาพหน้าจอของสไตล์ชีตที่ https://github.com/AninditaBasu/AninditaBasu.github.io/blob/master/gsod/Capture7.PNG7) นอกจากนี้ ฉันต้องการให้คำแนะนำเกี่ยวกับการใช้โทเค็น (ตัวยึดตำแหน่ง) ในสตริง โดยเฉพาะสตริงแบบผสม

   ผมจะเขียนคำแนะนำนี้ในชีตขนาด A4 เพียง 1 หน้า แต่หากเป็นไปได้ก็ให้สั้นลง ดังนั้น นักพัฒนาซอฟต์แวร์ที่เขียนสตริงเหล่านี้จริงๆ ควรจะพบคําแนะนําได้อย่างรวดเร็วและง่ายดาย และเมื่อทำตาม ข้อความ UI จะแสดงความสอดคล้องในทุกหน้าจอ

   ฉันเสนอให้ทำเช่นนี้ด้วยเหตุผล 2 ประการ คือ (ก) เพื่อให้ข้อความมีความสอดคล้องกันในด้านไวยากรณ์และรูปแบบ (ข) เพื่อที่ว่าแม้ GSoD จะสิ้นสุดลงแล้ว จะมีชุดคำสั่งที่ทุกคนสามารถอ้างถึงได้อย่างรวดเร็วเมื่อเขียนข้อความ UI

3. ตรวจสอบและปรับแต่งข้อความ

   ฉันจะแก้ไขสตริงและสร้างพุลคำขอที่ GitHub ตามคู่มือสไตล์ที่สร้างขึ้นเมื่อ #2

=============

ระยะเวลา

ฉันยังไม่ทราบจํานวนสตริงที่แสดงต่อผู้ใช้ (ซึ่งเป็นสิ่งที่ฉันเสนอให้ตรวจสอบในโปรเจ็กต์นี้) ฉันคาดว่าการสร้างคู่มือสไตล์จะใช้เวลาประมาณ 3 สัปดาห์ (ตั้งแต่ฉบับร่างไปจนถึงการอนุมัติ) และการดำเนินการนี้จะทำได้พร้อมกัน ด้วยการจัดหมวดหมู่สตริงให้เป็นสตริงของระบบหรือแสดงต่อผู้ใช้ ฉันเสนอให้เริ่มด้วยการตั้งสมมติฐานว่าโปรเจ็กต์จะเป็นโปรเจ็กต์ที่มีความยาวมาตรฐาน (3 เดือน) ซึ่งฉันจะตรวจสอบเพียงจำนวนหลายสตริงเพื่อให้ตรวจสอบได้ภายในกรอบเวลานี้

เนื่องจากฉันทำงานประจำอยู่แล้ว ฉันจึงสามารถทำงานในโครงการนี้ได้เพียงบางช่วงของวัน ฉันยินดีให้โปรเจ็กต์ที่มีระยะเวลานานขึ้นได้หากคิดว่าเวลาทำงานที่ลดลงของฉันจะต้องใช้โปรเจ็กต์นั้น