โครงการครีเอทีฟคอมมอนส์

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

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

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

ครีเอทีฟคอมมอนส์

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

JackieBinya

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

คู่มือการใช้งานธีมพื้นฐานของ WordPress

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

ระยะเวลามาตรฐาน (3 เดือน)

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

ในช่วงสมัครเข้าร่วมโปรแกรม GSOD-2020 ในฐานะผู้เขียนเนื้อหาทางเทคนิค ฉันได้พูดคุยกับ Hugo Solar ซึ่งเป็นที่ปรึกษาของโปรเจ็กต์เอกสารประกอบธีมพื้นฐาน WordPress ของ Creative Commons หลายครั้ง

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

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

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

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

ฉันนำความคิดเห็นที่ได้รับและข้อเสนอสุดท้ายสำหรับเอกสารการสร้างป้าย D&I มาใช้ในลิงก์ด้านล่างเป็นเอกสารใน Google เอกสาร

https://docs.google.com/document/d/1XmIsMTLstbhRRSaNFP538YOXJiS0G5QrN6EzuqJfRy4/edit?usp=sharing

หรือดูสรุปสั้นๆ ของข้อเสนอได้ที่ด้านล่าง

ครีเอทีฟคอมมอนส์ - คู่มือการใช้งานธีมพื้นฐานของ WordPress ข้อเสนอที่จัดทำโดย Jacqueline Binya, 28 มิถุนายน 2020

ข้อมูลสรุปของโปรเจ็กต์ เป้าหมายสูงสุดของโปรเจ็กต์นี้คือการสร้างเอกสารประกอบที่แสดงต่อชุมชนอย่างน่าสนใจ ใช้งานง่าย สมบูรณ์ และสวยงามสำหรับธีมพื้นฐาน WordPress ของ Creative Commons

แผนโปรเจ็กต์ ปัญหา ปัจจุบันธีม Creative Commons WordPress Base ไม่มีเอกสารประกอบ ซึ่งทำให้การใช้ธีมภายในชุมชนเป็นไปอย่างไม่มีประสิทธิภาพ เป้าหมายของเราคือสร้างคู่มือการใช้งานที่สมบูรณ์สำหรับธีมนี้ รวมถึงใช้การแยกความคิดในโค้ดเบสปัจจุบันของธีม WP Base เพื่อให้ใช้งานธีมได้ง่ายขึ้น

โซลูชัน สร้างเอกสารล้ำสมัยโดยใช้เฟรมเวิร์กสมัยใหม่อย่าง Gatsby Gatsby มีเงื่อนไขเริ่มต้นที่เราสามารถใช้เพื่อเริ่มต้นใช้งานเอกสารประกอบธีมพื้นฐานของ WordPress ใหม่ ตัวอย่างเงื่อนไขเริ่มต้นคือ gatsby-gitbook-starter ซึ่งออกมาจากกล่องซึ่งขับเคลื่อนโดยการปรับแต่งเว็บไซต์ให้ติดอันดับบนเครื่องมือค้นหา (SEO), มาร์กดาวน์ และ Algolia ( เครื่องมือที่ใช้ในการผสานรวมสำหรับการค้นหาในเว็บไซต์แบบคงที่) นอกจากนี้ เว็บไซต์ใดก็ตามที่สร้างโดย Gatsby จะสามารถเพิ่มประสิทธิภาพเพื่อการผสานรวมการปรับให้เป็นสากลและการเข้าถึงได้อย่างง่ายดาย ในการสร้างเอกสารประกอบ เราตั้งใจที่จะทำให้เข้าใจได้ง่ายที่สุดโดยวิธีต่อไปนี้ - เขียนเอกสารในลักษณะที่เข้าใจง่ายและพยายามหลีกเลี่ยงความคลุมเครือ รวมถึงการใช้คำศัพท์ทางเทคนิคที่ซับซ้อนมากเกินไป - โดยใส่ภาพประกอบและสื่อไว้ในเอกสารประกอบเพื่อใช้เป็นภาพประกอบสำหรับการเรียนรู้ - ใช้ตัวอย่างที่แสดงวิธีทํางานทั่วไป เช่น การปรับแต่ง

การแยกความคิดที่เราหวังว่าจะนำมาใช้งานจะรวมถึงการทำให้ผู้ใช้สามารถใช้ประโยชน์จากฟังก์ชันหลักส่วนใหญ่ของธีม WP Base เช่น ฮุก จากแผงการดูแลระบบ WordPress นอกจากนี้ เราอยากจะสร้างธีมย่อยเริ่มต้นสำหรับ WP Base Theme ในที่เก็บแยกต่างหากด้วย การมีธีมย่อยเริ่มต้นจะช่วยให้ผู้ใช้ใหม่เริ่มต้นใช้งานได้ง่ายและรวดเร็วขึ้น เมื่อเอกสารเสร็จสมบูรณ์และผ่านการอนุมัติแล้ว ก็จะได้รับการเผยแพร่และโฮสต์ทางออนไลน์

โครงสร้างที่เสนอของคู่มือการใช้งานธีมพื้นฐาน CC WordPress - เอกสารประกอบที่เสนอจะแบ่งออกเป็นส่วนต่างๆ ตามที่ระบุไว้ด้านล่าง รายการย่อยของแต่ละหัวข้อที่เสนอจะให้รายละเอียดเพิ่มเติมเกี่ยวกับเนื้อหาจริงที่จะพบในส่วนที่เกี่ยวข้อง

ส่วนภาพรวม - ระบุคำจำกัดความ เจตนา และฟีเจอร์ของธีมพื้นฐาน WordPress ภายใต้สัญญา Creative Commons(CC) * คำจำกัดความ: อธิบายธีมฐานของ CC WP คร่าวๆ * ความตั้งใจ: สรุปจุดมุ่งหมาย/ เจตนาของ CC WP Base Theme * ฟีเจอร์: สรุปฟีเจอร์ของ CC WP Base Theme

ส่วนเริ่มต้นใช้งาน - ข้อกำหนด * สรุปข้อกำหนดในการติดตั้ง CC WordPress Base Theme เช่น - เวอร์ชัน WordPress - เวอร์ชัน PHP - Composer ฯลฯ - คู่มือการติดตั้ง * สรุปวิธีที่ผู้ใช้สามารถใช้ไฟล์ ZIP เพื่อติดตั้ง CC ธีม WordPress * สรุปวิธีที่ผู้ใช้สามารถเริ่มต้นใช้งานด้วยการโคลนธีมพื้นฐาน WP จาก GitHub * ระบุวิธีที่ผู้ใช้สามารถติดตั้งข้อกำหนดในโปรเจ็กต์ * อธิบายวิธีที่ผู้ใช้สามารถกําหนดค่า Queulat ของ Dependency * อธิบายวิธีที่ผู้ใช้สามารถเปิดใช้งานธีมในสภาพแวดล้อมการพัฒนา WordPress ในเครื่อง

คู่มือการใช้งาน - ภาพรวม * อธิบายคำว่า "ธีมย่อย" * ระบุประโยชน์ของการใช้ธีมย่อย * แจ้งให้ผู้ใช้ทราบว่าวิธีแก้ไขธีม WP Base ที่แนะนำคือผ่านธีมย่อย * ไฮไลต์ว่าต้องติดตั้งและเปิดใช้งานธีม WP Base ก่อน ผู้ใช้จึงจะสร้างธีมย่อยได้

การใช้ธีมย่อย - อธิบายวิธีที่ผู้ใช้สร้างธีมย่อยของธีม WP Base โดยใช้เงื่อนไขเริ่มต้น ใช้วิดีโอเพื่ออธิบายวิธีที่ผู้ใช้สร้างธีมย่อยจากเงื่อนไขเริ่มต้น

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

ส่วนการปรับแต่งขั้นสูง - ส่วนการปรับแต่ง CSS * อธิบายคอมโพเนนต์ที่ประกอบกันเป็นสไตล์ของธีม - คําศัพท์ CC - Bulma - Sass * อธิบายวิธีตั้งค่า Sass ในโปรเจ็กต์ คําอธิบายควรมีข้อมูลเกี่ยวกับสิ่งต่อไปนี้ (1) ตําแหน่งของไฟล์ sass ในโครงสร้างโปรเจ็กต์ (2) สคริปต์ npm ที่สามารถใช้สร้างและตรวจสอบ sass * อธิบายวิธีที่ผู้ใช้ปรับแต่งสไตล์ sass ในธีมย่อยได้ เช่น ผ่านการติดตั้ง npm ที่ต้องพึ่งพาโดยเฉพาะ * อธิบายวิธีใช้คลาสคอมโพเนนต์ (class-component.php) เพื่อปรับแต่งสไตล์ของคอมโพเนนต์ที่เฉพาะเจาะจง

• ส่วนฮุก

• ภาพรวม

  • อธิบายคำว่าฮุก
  • อธิบายเหตุผลที่ผู้ใช้ควรใช้ประโยชน์จากฮุก
  • สรุปประเภทของฮุกที่ใช้ได้

• การใช้การดำเนินการ

  • แสดงรายการการดำเนินการที่มีอยู่ในธีม WP Base และตำแหน่งของการดำเนินการ
  • อธิบายวิธีนำการดำเนินการเหล่านี้ไปใช้

*การใช้ตัวกรอง - ระบุตัวกรองที่มีอยู่ในธีมและอธิบายวิธีใช้งานตัวกรองเหล่านั้น

ส่วนการอัปเดตธีม - อธิบายวิธีที่ผู้ใช้อัปเดตธีมได้

ส่วนการอนุญาตให้ใช้สิทธิ * อธิบายการอนุญาตให้ใช้สิทธิของโปรเจ็กต์และความหมายสำหรับผู้ที่อาจต้องการใช้ธีม CC WP Base ในโปรเจ็กต์ส่วนตัว

ส่วนการมีส่วนร่วม * เพิ่มคำแนะนำการมีส่วนร่วมโดยละเอียด * ระบุหลักจรรยาบรรณ * ชุมชน: ให้ข้อมูลเกี่ยวกับช่องชุมชนครีเอทีฟคอมมอนส์และวิธีที่ผู้มีส่วนร่วมจะเข้าร่วมได้ เป็นต้น