หน้านี้มีรายละเอียดของโครงการการเขียนเชิงเทคนิคที่ยอมรับสำหรับ Google Season of Docs
ข้อมูลสรุปของโปรเจ็กต์
- องค์กรโอเพนซอร์ส:
- WordPress
- ผู้เขียนด้านเทคนิค:
- tacitonic
- ชื่อโปรเจ็กต์:
- ชุดคู่มือสไตล์เอกสารประกอบฉบับสมบูรณ์และต่ออายุ
- ระยะเวลาของโปรเจ็กต์:
- วิ่งเป็นเวลานาน (5 เดือน)
คำอธิบายโปรเจ็กต์
เรื่องย่อ:
WordPress เป็นองค์กรซอฟต์แวร์ระดับโลกที่ไม่แสวงผลกำไร ซึ่งมุ่งมั่นที่จะให้บริการชุมชนทั่วโลกด้วยซอฟต์แวร์ที่เน้นการเข้าถึงได้ง่าย ประสิทธิภาพ การรักษาความปลอดภัย และความสะดวกในการใช้งาน จุดประสงค์ของ WordPress มุ่งมั่นที่จะทำให้ซอฟต์แวร์การเผยแพร่และซอฟต์แวร์โอเพนซอร์สในเว็บเป็นประชาธิปไตย ในยุคดิจิทัลของเรา เว็บไซต์เปรียบเสมือนส่วนหน้าขององค์กร/บุคคลธรรมดาทางออนไลน์ และ WordPress ให้บริการที่มากมายซึ่งให้บริการผู้ใช้หลายร้อยล้านรายอย่างมีประสิทธิภาพ ด้วยซอฟต์แวร์ที่คิดเป็น 35% ของอินเทอร์เน็ตที่ใช้งาน เพื่อให้บริการผู้ใช้เหล่านี้อย่างมีประสิทธิภาพต่อไป เอกสารประกอบจึงเป็นสิ่งจำเป็นและมีการใช้งานโดยนักพัฒนาซอฟต์แวร์ ผู้ดูแลระบบ และผู้ใช้ปลายทางส่วนใหญ่ ดังนั้นจึงสามารถสร้างเอกสารที่เป็นปัจจัยหลักของระบบนิเวศ WordPress ได้ เอกสาร WordPress ปัจจุบันไม่มีชุดกฎสากลและแบบรวม ตลอดจนหลักเกณฑ์เกี่ยวกับสไตล์สำหรับการเผยแพร่ แรงจูงใจของข้อเสนอนี้คือการสร้างหลักเกณฑ์เกี่ยวกับรูปแบบเอกสารทั้งชุดและต่ออายุใหม่ ซึ่งสามารถนำไปใช้กับเอกสาร WordPress ได้ทั่วโลก แนวคิดของโครงการประกอบด้วยการรวมแง่มุมทั้งหมดของหลักเกณฑ์การออกแบบและสไตล์ เช่น อรรถศาสตร์ ไวยากรณ์ หลักเกณฑ์ไวยากรณ์ เครื่องหมายวรรคตอน กฎเฉพาะสำหรับการพัฒนา แอตทริบิวต์การออกแบบ และการจัดรูปแบบเฉพาะ นอกจากนี้ยังใช้โครงสร้างทางภาษาต่างๆ เช่น โทนเสียง โทนเสียง อารมณ์ขัน ทุกส่วนของคำ รวมถึงการตั้งชื่อ เครื่องมือ ภาษา และแพลตฟอร์มที่ใช้จะเป็น WordPress CMS, GitHub, Markdown และอาจประกอบด้วย PHP/MySQL, HTML/CSS และ JavaScript
แผนโครงการ:
สถานะปัจจุบันของเอกสาร WordPress นั้น: ทีมจัดทำเอกสาร WordPress ได้นำหลักเกณฑ์การเผยแพร่ที่ไม่มีการประกาศออกมาเป็นเอกฉันท์ แต่ในบางครั้ง องค์ประกอบบางอย่างก็จะถูกคาดการณ์และกระบวนการก็จะไม่แน่นอน ไม่มีมาตรฐานและเกณฑ์ที่ตายตัวสำหรับการเขียนและเผยแพร่บทความสำหรับ WordPress ทีมเอกสารประกอบได้เขียนหลักเกณฑ์เกี่ยวกับสไตล์เฉพาะโปรเจ็กต์ไว้ แต่ไม่มีหลักเกณฑ์ใดที่นำไปใช้ได้ในทุกระดับ หลักเกณฑ์สไตล์ส่วนใหญ่ที่มีอยู่ไม่ได้รวมอยู่ในคู่มือเล่มเดียว หรือเลิกใช้งานไปแล้วและจำเป็นต้องอัปเดต ด้วยเหตุนี้คุณจึงต้องออกแบบและพัฒนาคู่มือสไตล์ที่รวมเป็นหนึ่งเพื่อให้เอกสาร WordPress มีมาตรฐาน
วัตถุประสงค์:
เว็บไซต์บนอินเทอร์เน็ตมากกว่า 35% ใช้ WordPress ซึ่งแสดงโดยนักพัฒนาและผู้ใช้ปลายทางนับล้านที่ใช้ประโยชน์จากฟังก์ชันอันน่าทึ่งของ WordPress เอกสารประกอบเป็นองค์ประกอบสำคัญที่จะช่วยให้นักพัฒนาซอฟต์แวร์และผู้ใช้เหล่านี้ตอบสนองฟังก์ชันการทำงานเหล่านี้ได้อย่างมีประสิทธิภาพโดยไม่ยุ่งยาก แม้ในกรณีที่ไม่สะดวกก็ตาม วัตถุประสงค์โดยรวมของข้อเสนอโปรเจ็กต์นี้คือการทำให้คู่มือการออกแบบและสไตล์เป็นมาตรฐาน รวมคู่มือสไตล์ที่มีอยู่และอัปเดต รวมถึงเพิ่มข้อบังคับและข้อกำหนดใหม่ๆ สำหรับเอกสารประกอบของ WordPress ซึ่งจะทำให้เอกสารของ WordPress ใช้งานง่าย ไม่ซับซ้อน และเป็นรูปแบบเดียวกัน
การนำไปใช้งาน:
ตามที่ที่ปรึกษา (Jon Ang) แนะนำสำหรับโครงการนี้ สามารถดำเนินโครงการได้ใน 4 ระยะ ได้แก่ ระยะการค้นพบ การกำหนดคำจำกัดความ การใช้งาน และการบำรุงรักษา ก่อนที่จะเริ่มโครงการ ในช่วงก่อนฝึกงาน ฉันจะทำงานร่วมกับที่ปรึกษาและสรุปกำหนดเวลาและลำดับเวลาที่เหมาะสมให้สอดคล้องกับไทม์ไลน์และการดำเนินการที่จะส่งมอบในอนาคต ฉันจะทำความคุ้นเคยกับระบบ WordPress และโปรโตคอลการทำงานสำหรับโครงการนี้
เมื่อเริ่มฝึกงาน ฉันจะพูดคุยและร่างบทสรุปของแผนกับที่ปรึกษาของฉัน โดยจะมีการกำหนดข้อกำหนดและความจำเป็น ก่อนอื่น เราจะพูดถึงขั้นตอนของเอกสารและขั้นตอนการโต้ตอบของผู้ใช้ หลังจากนั้น เฟรมไวร์เฟรมของแต่ละส่วน หมวดหมู่ และองค์ประกอบจะมีการสรุปออกไป จากนั้น ที่ปรึกษาของฉันจะตรวจสอบเลย์เอาต์เหล่านี้ หากจำเป็น เลย์เอาต์จะมีการออกแบบใหม่และเพิ่ม/นำองค์ประกอบบางอย่างออก จากนั้นเราจะทำการศึกษาวิจัยผู้ใช้เพื่อระบุความสามารถในการใช้งานและความเป็นไปได้ของการทำงานของอินเทอร์เฟซ หลังจากนั้น เราจะนำคู่มือแนะนำรูปแบบเอกสารประกอบไปใช้ (ดังที่แสดงในแผนภาพด้านล่าง) ตามแต่ละหัวข้อ คู่มือแนะนำรูปแบบจากองค์กรอื่นๆ ที่อยู่ภายใต้ใบอนุญาตโอเพนซอร์สหรือสัญญาอนุญาตครีเอทีฟคอมมอนส์ (Creative Commons License) สามารถนำมาอ้างอิงเพื่อเพิ่มคู่มือของเราได้เช่นกัน หากเกิดความไม่สะดวกในการใช้งานในระหว่างนี้ เราจะออกแบบการออกแบบใหม่
การทดสอบและเพิ่มประสิทธิภาพจะเกิดขึ้นหลังจากที่คู่มือสไตล์การแปลเสร็จสมบูรณ์และผสานรวมกับ HelpHub แล้ว ช่องโหว่ องค์ประกอบหรือองค์ประกอบที่ซ้ำซ้อนจะได้รับการแก้ไข จะมีการทดสอบ UI และโค้ด รวมถึงแก้ไขข้อบกพร่องและข้อผิดพลาดที่ไม่พึงประสงค์ หากจำเป็น จะมีการควบคุมคุณภาพขั้นสุดท้ายสำหรับคู่มือสไตล์ฉบับสมบูรณ์สำหรับด้านภาษา ไวยากรณ์ การสะกดคำ เครื่องหมายวรรคตอน ฯลฯ
งานที่รอดำเนินการเนื่องจากความล่าช้าที่ไม่คาดคิดจะเสร็จสมบูรณ์ในช่วงบัฟเฟอร์ คุณนำฟังก์ชันหรือฟีเจอร์เพิ่มเติมที่อาจใช้ได้ในระหว่างโครงการมาใช้หลังจากทดสอบขั้นสุดท้ายเสร็จแล้ว ระบบจะสร้างแผนการติดตั้งใช้งานและมีการส่งผลิตภัณฑ์ที่เสร็จสมบูรณ์แล้ว
เครื่องมือและวิธีการ:
เอกสารจะได้รับการรวบรวมและแก้ไขบนแพลตฟอร์มการทำงานร่วมกัน เช่น Google เอกสาร หากจำเป็นต้องเผยแพร่ผ่าน GitHub คุณสามารถใช้ภาษามาร์กอัป เช่น Markdown หรือ GitHub Flavored Markdown ได้เช่นกัน นอกจากนี้ คุณยังอ้างอิงหลักเกณฑ์ของสไตล์โอเพนซอร์สสำหรับมาตรฐานการออกแบบและสไตล์ได้ด้วย ขั้นสุดท้าย เอกสารที่สมบูรณ์จะได้รับการจัดรูปแบบและเผยแพร่โดยใช้ WordPress
ตารางคอมโพเนนต์:
นี่เป็นรายการคอมโพเนนต์โดยละเอียดที่นำไปใช้ในคู่มือสไตล์ได้ หลักเกณฑ์ของเอกสาร - การเข้าถึง, โครงสร้างเอกสาร, การเข้ารหัส, แหล่งข้อมูลภายนอก, ข้อเท็จจริง, แบบอักษร, ผู้ชมทั่วโลก, การไม่แบ่งแยก, ความชอบด้วยกฎหมาย, การเข้าถึงได้หลายแพลตฟอร์ม, ไม่กำกวม, ไม่มีการอ้างสิทธิ์มากเกินไป, รูปแบบหน้า, ความถูกต้องทางการเมือง, โปรโตคอล, ความปลอดภัย, โครงสร้างประโยค, การเขียนให้กระชับ, น้ำเสียงและสไตล์, ไม่ลำเอียง
ภาษาและไวยากรณ์ - คำย่อและตัวย่อ คำยืนยันและการปฏิเสธ บทความ การใช้อักษรตัวพิมพ์ใหญ่ วรรค คำพูดทางตรง/ทางอ้อม บุคคลที่หนึ่ง/ที่สอง/บุคคลที่สาม เพศ อภิธานศัพท์ คำนาม คำนำหน้าและคำต่อท้าย คำบุพบท คำสรรพนาม การอ้างอิง คำสแลงและศัพท์เฉพาะ การสะกด และคำศัพท์ทางเทคนิค
เครื่องหมายวรรคตอน - เครื่องหมายอะพอสทรอฟีและเครื่องหมายคำพูด โคลอนและโคลอน โคลอน เครื่องหมายจุดไข่ปลา เครื่องหมายอัศเจรีย์ ขีดกลางและขีดกลางยาว วงเล็บ เครื่องหมายจุด เครื่องหมายคำถาม เครื่องหมายทับ
การจัดรูปแบบ - นามธรรม, บทนำ, บทนำ, ชื่อแบรนด์, ชื่อผลิตภัณฑ์, คำบรรยาย, ตัวอย่างโค้ด, บล็อกโค้ด, วันที่และเวลา, เขตเวลา, สถานที่, สกุลเงิน, ชื่อไฟล์, เชิงอรรถ, ส่วนหัวและชื่อ, การเน้น (ตัวหนา, ตัวเอียง, ขีดเส้นใต้, ขีดทับ, การอ้างอิง, หมายเลขกำกับ, หมายเลข, ลิงก์ หรือ URL, หัวข้อย่อย, คำอธิบาย, URL, หัวข้อย่อย, คำอธิบาย, หมายเลขและหมายเลข)
อินเทอร์เฟซผู้ใช้ - กิจกรรม, ปุ่ม, ข้อมูลโค้ด, บล็อกโค้ด, อินเทอร์เฟซบรรทัดคำสั่ง, กล่องโต้ตอบ, เมนูและรายการแบบเลื่อนลง, ป๊อปอัปและการแจ้งเตือน, แท็บ, คำศัพท์, องค์ประกอบ UI, Windows
โค้ด - CSS, HTML, JS, Markdown, MySQL, PHP, ไวยากรณ์, XML
พจนานุกรมการใช้คำ/อภิธานศัพท์ - A ถึง Z