หน้านี้มีรายละเอียดโครงการงานเขียนเชิงเทคนิคที่ได้รับการยอมรับใน Google Season of เอกสาร
สรุปโปรเจ็กต์
- องค์กรโอเพนซอร์ส:
- 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 และโปรโตคอลการทำงานสำหรับโปรเจ็กต์นี้เพิ่มเติม
เมื่อเริ่มฝึกงาน เราจะปรึกษาและร่างข้อมูลสรุปของแผนกับที่ปรึกษา ระบบจะกำหนดข้อกำหนดและความจำเป็น ก่อนอื่น เราจะอธิบายขั้นตอนของเอกสารประกอบและกระบวนการโต้ตอบของผู้ใช้ จากนั้น โครงร่างของไวร์เฟรมของแต่ละส่วน หมวดหมู่ และส่วนประกอบจะได้รับการอธิบาย จากนั้นที่ปรึกษาของฉันจะตรวจสอบเลย์เอาต์เหล่านี้ หากจำเป็น ระบบจะออกแบบเลย์เอาต์ใหม่และเพิ่ม/นำคอมโพเนนต์บางรายการออก จากนั้นเราจะทำการศึกษาวิจัยผู้ใช้เพื่อพิจารณาความสามารถในการใช้งานและความเป็นไปได้ของขั้นตอนในอินเทอร์เฟซ จากนั้นจะนำคู่มือสไตล์เอกสารประกอบมาใช้ (ดังที่แสดงในแผนภาพด้านล่าง) ตามแต่ละส่วน คุณสามารถใช้คู่มือสไตล์จากองค์กรอื่นๆ ที่อยู่ภายใต้สัญญาอนุญาตโอเพนซอร์สหรือครีเอทีฟคอมมอนส์เพื่อเสริมคู่มือของเราได้เช่นกัน หากในระหว่างนี้เกิดปัญหาด้านความสามารถในการใช้งาน เราจะออกแบบใหม่
การทดสอบและการเพิ่มประสิทธิภาพจะดำเนินการหลังจากคู่มือสไตล์เสร็จสมบูรณ์และผสานรวมกับ HelpHub แล้ว ช่องโหว่ องค์ประกอบ หรือคอมโพเนนต์ที่ซ้ำซ้อนจะได้รับการแก้ไข ระบบจะทำการทดสอบ UI และโค้ด รวมถึงแก้ไขข้อบกพร่องและข้อผิดพลาดที่ไม่พึงประสงค์ (หากจำเป็น) การควบคุมคุณภาพขั้นสุดท้ายสำหรับคู่มือสไตล์ฉบับสมบูรณ์จะดำเนินการเกี่ยวกับภาษา ไวยากรณ์ การสะกด เครื่องหมายวรรคตอน ฯลฯ
งานที่รอดำเนินการเนื่องจากความล่าช้าที่ไม่คาดคิดจะเสร็จสิ้นในช่วงบัฟเฟอร์ ฟังก์ชันการทำงานหรือฟีเจอร์เพิ่มเติมที่พิจารณาแล้วว่าทำได้ในระหว่างการดำเนินโครงการสามารถนำมาใช้งานได้หลังจากการทดสอบขั้นสุดท้ายเสร็จสิ้นแล้ว ระบบจะสร้างแผนการใช้งานและส่งผลิตภัณฑ์ที่เสร็จสมบูรณ์
เครื่องมือและวิธีการ
ระบบจะรวบรวมและแก้ไขเอกสารประกอบในแพลตฟอร์มการทำงานร่วมกัน เช่น Google เอกสาร หากจำเป็นต้องเผยแพร่ผ่าน GitHub คุณจะใช้ภาษามาร์กอัปอย่าง Markdown หรือ GitHub Flavored Markdown ได้ด้วย สำหรับมาตรฐานการออกแบบและสไตล์ คุณยังอ้างอิงหลักเกณฑ์สไตล์โอเพนซอร์สได้ด้วย สุดท้าย เอกสารที่เสร็จสมบูรณ์จะได้รับการจัดรูปแบบและเผยแพร่โดยใช้ WordPress
ตารางคอมโพเนนต์
นี่เป็นรายการคอมโพเนนต์ทั้งหมดที่นำไปใช้ในคู่มือสไตล์ได้ หลักเกณฑ์ของเอกสาร - การช่วยเหลือพิเศษ, โครงสร้างเอกสาร, การเข้ารหัส, แหล่งที่มาภายนอก, ข้อเท็จจริง, แบบอักษร, ผู้ชมทั่วโลก, การไม่แบ่งแยก, กฎหมาย, ความสามารถเข้าถึงได้ง่ายในหลายแพลตฟอร์ม, ไม่กำกวม, ไม่มีการกล่าวอ้างมากเกินไป, เลย์เอาต์หน้า, ความถูกต้องทางการเมือง, โปรโตคอล, ความปลอดภัย, โครงสร้างประโยค, การเขียนที่กระชับ, น้ำเสียงและสไตล์, ไม่มีอคติ
ภาษาและไวยากรณ์ - คำย่อและตัวย่อ การรับรองและนิเสธ บทความ การใช้อักษรตัวพิมพ์ใหญ่ วรรค คำพูดทางตรง/ทางอ้อม บุคคลที่หนึ่ง/ที่สอง/บุคคลที่สาม เพศ อภิธานศัพท์ คำนาม คำนำหน้าและคำต่อท้าย คำบุพบท คำสรรพนาม การอ้างอิง คำสแลงและศัพท์เทคนิค คำศัพท์ทางเทคนิค คำศัพท์ทางเทคนิค คำศัพท์ทางเทคนิค
เครื่องหมายวรรคตอน - เครื่องหมายเครื่องหมายกำกับการออกเสียงและเครื่องหมายคำพูด เครื่องหมายโคลอนและเครื่องหมายเซมิโคลอน เครื่องหมายคอมมา เครื่องหมายขีดกลาง เครื่องหมายตกใจ เครื่องหมายขีดกลางสั้นและเครื่องหมายขีดกลางยาว เครื่องหมายวงเล็บ เครื่องหมายจุด เครื่องหมายคำถาม เครื่องหมายทับ
การจัดรูปแบบ - ข้อมูลสรุป บทนำ คำนำ ชื่อแบรนด์ ชื่อผลิตภัณฑ์ คำบรรยาย ข้อมูลโค้ด บล็อกโค้ด วันที่และเวลา เขตเวลา สถานที่ สกุลเงิน ชื่อไฟล์ เชิงอรรถ ส่วนหัวและชื่อ การไฮไลต์ (ตัวหนา ตัวเอียง ตัวขีดเส้นใต้ ตัวขีดทับ เครื่องหมายคำพูด) การเยื้อง ดัชนี ลิงก์และ URL รายการ หัวข้อย่อย การนับ สื่อ (รูปภาพ วิดีโอ) และภาพประกอบ หมายเหตุ คำเตือน เคล็ดลับ ตัวเลขและหมายเลขโทรศัพท์ หลายภาษา การแปล สคริปต์ภาษา ระยะห่าง ตาราง ข้อความ เครื่องหมายการค้า ลิขสิทธิ์ สิทธิบัตร การอ้างอิง บทแนะนำและขั้นตอน องค์ประกอบ UI หน่วยวัด
อินเทอร์เฟซผู้ใช้ - กิจกรรม, ปุ่ม, ข้อมูลโค้ด, บล็อกโค้ด, อินเทอร์เฟซบรรทัดคำสั่ง, กล่องโต้ตอบ, เมนูและเมนูแบบเลื่อนลง, ป๊อปอัปและการแจ้งเตือน, แท็บ, คำศัพท์, องค์ประกอบ UI, Windows
โค้ด - CSS, HTML, JS, Markdown, MySQL, PHP, ไวยากรณ์, XML
พจนานุกรม/อภิธานศัพท์การใช้คํา - A ถึง Z