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

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

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

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

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

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

JackieBinya

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

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

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

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

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

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

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

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

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

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

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

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

อีกทางเลือกหนึ่งคือข้อมูลสรุปสั้นๆ เกี่ยวกับข้อเสนอของเรา ซึ่งมีรายละเอียดอยู่ด้านล่างนี้:

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

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

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

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

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

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

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

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

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

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

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

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

• ส่วนตะขอ

• ภาพรวม

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

• การใช้การทำงาน

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

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

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

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

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