โปรเจ็กต์ Mattermost

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

สรุปโปรเจ็กต์

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

Mattermost

นักเขียนเชิงเทคนิค:

@anindita_basu

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

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

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

ดำเนินงานมาอย่างยาวนาน (5 เดือน)

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

ผมจึงเข้าร่วมช่อง Slack และได้ถามคำถามบางข้อกับ Eric ตาม
คำตอบของเขา (ขอขอบคุณ 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.PNG) นอกจากนี้ เราต้องการจัดทำคำแนะนำเกี่ยวกับการใช้โทเค็น (ตัวยึดตำแหน่ง) ในสตริง โดยเฉพาะสตริงคอมโพสิท

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

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

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

   เราจะแก้ไขสตริงและสร้างคำขอดึงข้อมูลใน GitHub โดยอิงตามคู่มือสไตล์ที่สร้างขึ้นที่ #2

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

ระยะเวลา

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

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