โครงข่ายอิเล็กตรอน

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

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

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

อิเล็กตรอน

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

มิสเตอร์โกลด์

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

การเคลื่อนตัวของอิเล็กตรอน

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

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

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

สรุปโครงการ

Electron เป็นหนึ่งในเครื่องมือยอดนิยมในการสร้างแอปบนเดสก์ท็อปข้ามแพลตฟอร์มด้วย JavaScript, HTML และ CSS คอลเล็กชันของแอปที่สร้างด้วยอิเล็กตรอนมีรายการเกือบ 900 รายการและมีจำนวนรายการเพิ่มขึ้นอย่างต่อเนื่อง เครื่องมือสำหรับนักพัฒนาซอฟต์แวร์ที่ได้รับความนิยมสูงสุด เช่น Visual Studio Code, Atom, Postman, Slack, GitKraken นั้นสร้างขึ้นจาก Electron

ความนิยมของ Electron อยู่ในเส้นโค้งการเรียนรู้อย่างง่ายและเกณฑ์การเข้าที่ต่ำ ดังนั้น ทุกคนที่รู้ JavaScript, HTML และสแต็ก CSS สามารถสร้างแอปพลิเคชันของตัวเองได้ อัตราการเติบโตโดยรวมอย่างมากเป็นตัวกำหนดความจำเป็นในการสร้างบทแนะนำและคู่มือเริ่มต้นใช้งานที่เข้าใจและใช้งานได้ง่าย

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

ปัญหาเกี่ยวกับโปรเจ็กต์

ต่อไปนี้คือรายการปัญหาที่สำคัญที่สุดที่เกี่ยวข้องกับเอกสารบทแนะนำเกี่ยวกับอิเล็กตรอน 1. จุดเริ่มต้นที่ไม่ชัดเจนและข้อมูลแนะนำที่ไม่ค่อยเข้าใจเกี่ยวกับขั้นตอนการพัฒนาแอปพลิเคชัน 2. ข้อมูลที่กระจัดกระจายและซ้ำซ้อนที่เกี่ยวข้องกับกระบวนการพัฒนาแอปพลิเคชัน 3. คำแนะนำสำหรับการ "เริ่มต้นใช้งาน" ที่เป็นระเบียบและไม่มีแหล่งข้อมูลที่เชื่อถือได้เพียงแหล่งเดียว

ข้อเสนอโครงการ

ตามเป้าหมายของโปรเจ็กต์และปัญหาที่ระบุไว้ด้านบน ต่อไปนี้เป็นรายการการเพิ่มประสิทธิภาพที่เสนอ 1. อัปเดตคู่มือที่มีอยู่ เพื่อให้ขั้นตอนแรกเป็นไปอย่างราบรื่นและสอดคล้องกัน คุณควรอัปเดตเอกสารต่อไปนี้โดยค่อยๆ เปลี่ยนจากแบบง่ายไปเป็นแบบซับซ้อนมากขึ้น - สภาพแวดล้อมของนักพัฒนาซอฟต์แวร์ - การเขียนแอปอิเล็กตรอนรายการแรก - การเพิ่มฟีเจอร์ลงในแอป (สร้างหน้าสรุป) - การจัดแพ็กเกจและการจัดจำหน่ายแอป 2. ปรับโครงสร้างไดเรกทอรีเอกสารประกอบ เพื่อแสดงให้นักพัฒนาซอฟต์แวร์รายใหม่เห็นถึงสิ่งที่จำเป็นในการเริ่มต้นใช้งานและสิ่งที่ถือว่าเป็นขั้นตอนต่อๆ ไป หน้าเอกสารควรมีการแบ่งส่วนภาพและบริบทของขั้นตอนเพื่อทำให้แอปพลิเคชันแรกทำงานได้อย่างรวดเร็วที่สุดเท่าที่จะเป็นไปได้ รวมถึงให้คำแนะนำเกี่ยวกับขั้นตอนถัดไปที่ทำได้ 3. จัดระเบียบและรวมเอกสารประกอบการพัฒนาแอปพลิเคชันเข้าไว้ด้วยกัน ฟีเจอร์ทั้งหมดควรมีชุดคำแนะนำแบบรวมวิธีการติดตั้ง/เปิดใช้ วิธีเริ่มต้นใช้งานอย่างรวดเร็ว วิธีใช้งานแอปหลังจากการเปิดใช้ครั้งแรก และวิธีเผยแพร่แอป 4. รวมที่เก็บ electron-api-demos ในเอกสารประกอบ ที่เก็บข้อมูล electron-api-demos ประกอบด้วยชุดตัวอย่างที่แสดงวิธีการเพิ่มคุณลักษณะลงในแอปพลิเคชัน Electron ของคุณ ข้อมูลนี้ควรรวมอยู่ในคู่มือการเพิ่มฟีเจอร์ในแอปของคุณเพื่อให้สอดคล้องกับกลยุทธ์เนื้อหาแหล่งข้อมูลที่เชื่อถือได้เพียงแหล่งเดียว 5. ผสานรวมตัวอย่างฟิดเดิลอิเล็กตรอนในเอกสารประกอบ ขั้นตอนนี้จะช่วยให้นักพัฒนาซอฟต์แวร์รายใหม่ดูวิธีการทำงานของโค้ดเฉพาะชิ้นได้ง่ายขึ้นโดยไม่ต้องทำตามขั้นตอนซ้ำด้วยตนเอง การผสานรวมนี้รวมถึงตัวอย่างการเขียนโค้ดสำหรับบทแนะนำที่อัปเดตแล้วและการเพิ่มปุ่ม "เปิดใน Fiddle" ลงในโค้ดบล็อก

ไทม์ไลน์

ระยะเวลาตรวจสอบใบสมัคร - ทำความคุ้นเคยในชุมชนและผู้คนที่ต้องการทำงานด้วย เรียนรู้คู่มือการสนับสนุนคำบรรยายของชุมชนและแนวทางปฏิบัติแนะนำ มีส่วนร่วมเป็นครั้งแรก การสานสัมพันธ์ในชุมชน - สำรวจชุมชน ตรวจสอบสถานะปัจจุบันของเอกสารอิเล็กตรอน ระบุจุดอ่อน สัปดาห์ที่ 1 - ปรับแนวทางกับที่ปรึกษาเป้าหมายของโครงการและสิ่งที่ส่งมอบ สัปดาห์ที่ 2 - แก้ไขสภาพแวดล้อมของนักพัฒนาซอฟต์แวร์และการเขียนหน้าแอปอิเล็กตรอนแรกของคุณ สัปดาห์ที่ 3 - แก้ไขสถาปัตยกรรมแอปพลิเคชัน การเพิ่มคุณลักษณะให้แอปของคุณ การจัดแพ็กเกจแอปและหน้าการเผยแพร่ สร้างหน้าสรุปที่มีรายการฟีเจอร์ที่สามารถเพิ่มในแอป สัปดาห์ที่ 4 - ปรับโครงสร้างไดเรกทอรีเอกสารประกอบ สัปดาห์ที่ 5 - เตรียมเทมเพลตสำหรับวิธีผสานรวมการสาธิตอิเล็กตรอน API ไว้ในเอกสารประกอบหลัก สัปดาห์ที่ 6 - 7 - ย้ายข้อมูลที่เก็บ electron-api-demos สัปดาห์ที่ 8 - เตรียมเทมเพลตเกี่ยวกับวิธีรวมการสาธิตอิเล็กตรอน (electron-api-demos ) ลงในเอกสารหลัก เขียนตัวอย่างแรก สัปดาห์ที่ 9-10 - ผสานฟิดเดิลอิเล็กตรอนเข้ากับเอกสารหลัก สัปดาห์ที่ 11 - การสรุปโครงสร้างเอกสารหลักและหน้าเว็บหลังจากการย้ายข้อมูลที่เก็บอิเล็กตรอน-API และตัวอย่างอิเล็กตรอนฟิดเดิล สัปดาห์ที่ 12 - การประเมินผลลัพธ์

การแจกแจงเป้าหมายโดยละเอียด

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

ช่วงที่ 2 ของช่วงนี้จะมุ่งเน้นไปที่การเรียนรู้วัฒนธรรมการมีส่วนร่วมโดยทั่วไป ทบทวนคู่มือการสนับสนุน และแนวทางปฏิบัติแนะนำ นี่จะเป็นเวลาที่คุณมีส่วนร่วมเป็นครั้งแรกเพื่อดูว่าขั้นตอนทำงานอย่างไร

การเชื่อมโยงกับชุมชน

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

สัปดาห์ที่ 1 - สัปดาห์ที่ 2

สัปดาห์แรกจะเป็นการสื่อสารกับที่ปรึกษาเพื่อให้สอดคล้องกับเป้าหมายที่คาดไว้และนำเสนอได้ทันท่วงที

สัปดาห์ที่ 2 จะเป็นเรื่องการแก้ไขสภาพแวดล้อมของนักพัฒนาซอฟต์แวร์และการเขียนหน้าแอปอิเล็กตรอนแรก สำหรับหน้าสภาพแวดล้อมของนักพัฒนาซอฟต์แวร์ หน้านี้จะมีการเขียนภาพรวมทั่วไปและการพิสูจน์อักษรใหม่ สำหรับหน้าการเขียนแอปอิเล็กตรอนรายการแรกของคุณ จะประกอบด้วยการทำให้หน้านี้เป็นคำแนะนำทีละขั้นตอนที่สอดคล้องกัน โดยมีจุดเริ่มต้นและจุดสิ้นสุดที่ชัดเจน การนำข้อมูลที่ซ้ำซ้อนออก (เช่น บล็อกโค้ดที่คล้ายกัน 2 บล็อกภายใต้ Electron Development in a Nutshell และการลองใช้ส่วนตัวอย่างนี้)

สิ่งที่ส่งมอบ: คู่มือแนะนำที่มีการปรับปรุงและทำตามได้ง่าย เกี่ยวกับวิธีการเริ่มต้นอย่างรวดเร็วด้วยแอปพลิเคชัน Electron

สัปดาห์ที่ 3

สัปดาห์นี้จะมีขึ้นเพื่อ: 1. การปรับปรุงหน้าสถาปัตยกรรมแอปพลิเคชัน ซึ่งประกอบด้วย - การเขียนข้อมูลที่มีอยู่ใหม่ในส่วนกระบวนการหลักและตัวแสดงผลเพื่อให้ผู้อ่านใช้งานเป็นครั้งแรกใช้งานได้ง่ายและเข้าใจง่ายขึ้น โดยเพิ่มการนำเสนอภาพสถาปัตยกรรม การเชื่อมโยงกระบวนการต่างๆ วิธีสื่อสาร และความแตกต่างหลักๆ ของกระบวนการ ตัวอย่างภาพ ได้แก่ 1, 2, 3 (คุณภาพต่ำ) 2. การรวมข้อมูลเกี่ยวกับคุณลักษณะทั้งหมดที่คุณสามารถเพิ่มในแอปพลิเคชัน Electron ของคุณ ซึ่งรวมถึงการเขียนคู่มือให้มีชุดวิธีการติดตั้ง/เปิดใช้ฟีเจอร์แบบรวมพร้อมกับตัวอย่างวิธีการทำงานของฟีเจอร์ นอกจากนี้ ระบบจะสร้างหน้าเว็บ (สรุป) ใหม่ที่แสดงฟีเจอร์ทั้งหมดที่ใช้ได้ วิธีการที่รวมกันอาจมีลักษณะดังนี้ - ภาพรวม - ตัวอย่าง - ตัวอย่างโค้ด - ภาพตัวอย่าง (หากเป็นไปได้)

1. ลดความซับซ้อนของหน้าการแจกจ่ายแอปพลิเคชัน ซึ่งรวมถึง: ก. การรวมแพ็กเกจแอปพลิเคชันไว้ในคำแนะนำในการแจกจ่ายแอปพลิเคชัน ข. แบ่งวิธีการแจกจ่ายเป็นแบบอัตโนมัติและแบบด้วยตนเอง ค. การยกอิเล็กตรอนเป็นตัวอย่างของการกระจายอัตโนมัติ ง. นำข้อมูลเกี่ยวกับ Asar จากหน้าแพ็กเกจแอปพลิเคชันและอธิบายการคัดลอกไฟล์ต้นฉบับและการสร้างที่เก็บถาวรแบบ Asar เป็นตัวอย่างของการเผยแพร่ด้วยตนเอง #### สัปดาห์ที่ 4 สัปดาห์นี้เราจะทำการปรับเปลี่ยนโครงสร้างไดเรกทอรีเอกสารประกอบ แอปประกอบด้วย

1 - แบ่งคำแนะนำที่มีอย่างน้อย 3 หมวดหมู่ ดังนี้ ก. การเริ่มต้นอย่างรวดเร็ว ข. การเรียนรู้พื้นฐาน ค. ขั้นตอนขั้นสูง

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

โครงสร้างอาจมีลักษณะดังนี้ 1. สิ่งที่ต้องมีก่อน 2. ติดตั้ง Electron 3. สร้างแอปพลิเคชันพื้นฐาน 4. บรรจุหีบห่อ/แจกจ่ายแอปพลิเคชัน

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

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

หมวดหมู่ขั้นตอนขั้นสูงจะมีคำแนะนำขั้นสูงเพิ่มเติมซึ่งมีจุดมุ่งหมายในการกำหนดค่าและปรับแต่งแอปพลิเคชัน Electron ของคุณ ดังนี้ - การทดสอบและแก้ไขข้อบกพร่อง - การช่วยเหลือพิเศษ - ความปลอดภัย - การอัปเดต

2 - ลดจำนวนหน้าเอกสาร เอกสารเวอร์ชันปัจจุบันมีเนื้อหาที่ทับซ้อนกันในระดับหนึ่งและคำสั่งที่ไม่จัดอยู่ในหมวดหมู่ใดๆ ตัวอย่างเช่น - การติดตั้งและการติดตั้งอิเล็กตรอนภายในการเขียนแอปแรกของคุณ - การสร้างแพ็กเกจและการรวมแอปไว้ในไฟล์ภายในการแจกจ่ายแอปพลิเคชัน - วิธีการที่ไม่จัดอยู่ในหมวดหมู่ในรายละเอียดและขั้นสูง: คำแนะนำ: ย้ายเอกสารต่อไปนี้ไปยัง GitHub และแยกออกจากเอกสารหลัก เอกสารเหล่านี้มีไว้สำหรับหลักเกณฑ์การพัฒนาอิเล็กตรอนโดยเฉพาะ และควรศึกษาเกี่ยวกับที่เก็บต้นทางก่อน - กำลังพัฒนาอิเล็กตรอน - การพัฒนาของ Chromium - การพัฒนา V8 - ปัญหาในอิเล็กตรอน - รอยปะในอิเล็กตรอน - คำขอแบบพุล - โครงสร้างไดเรกทอรีซอร์สโค้ด - การทดสอบ - การเขียนโค้ด

หลักในการลดจำนวนนี้คือการกำจัดคู่มือที่มีจำนวนมหาศาลให้หมดไป แล้วผนวกข้อมูลจิ๊กซอว์ที่กระจัดกระจายไว้ด้วยกัน และทำให้ผู้มาใหม่มีเอกสารเกี่ยวกับอิเล็กตรอนที่เป็นโครงสร้าง ไปยังส่วนต่างๆ ได้ง่าย และใช้งานง่าย

สัปดาห์ที่ 5-7

สัปดาห์ที่ 5 จะมุ่งเน้นไปที่การเตรียมเทมเพลต (วิธี) เกี่ยวกับวิธีผสานรวมการสาธิตอิเล็กตรอน-API เข้ากับเอกสารหลัก เทมเพลตนี้อาจมีลักษณะดังต่อไปนี้ 1. ในเอกสารหลัก ภายใต้ "การเพิ่มฟีเจอร์ในแอป" ให้สร้างหมวดหมู่ที่แสดงใน electron-api-demos 2. ในแต่ละหมวดหมู่ ให้โอนตัวอย่างสาธิตไปยังเอกสารหลัก ดังนี้ - ตัวอย่างโค้ดอาจมาจากซอร์สโค้ดหรือจากคำอธิบายฟีเจอร์ที่เกี่ยวข้องในแอปพลิเคชัน - ตัวอย่างที่โอนแต่ละรายการควรมีคำอธิบายที่เกี่ยวข้อง - ควรโอนตัวอย่างย่อยแต่ละรายการ (เช่น กล่องโต้ตอบข้อผิดพลาดเป็นส่วนย่อยของกล่องโต้ตอบ "ใช้ระบบ") ภายใต้ระดับบนสุด

หมายเหตุ #1: มีตัวอย่างทั้งในการสาธิตอิเล็กตรอน API และในเอกสารหลัก (เช่น แป้นพิมพ์ลัด การลากและวาง) ในกรณีนี้ ควรให้ความสำคัญกับตัวอย่างจาก electron-api-demos ก่อน และละเว้นตัวอย่างในเอกสารหลัก

หมายเหตุ #2: ตัวอย่างจำนวนมากในแอปพลิเคชัน electron-api-demos จะมีตัวอย่างการสาธิตแบบสดของคุณลักษณะหรือฟังก์ชันการทำงานที่อธิบาย ฟังก์ชันนี้จะถูกละเว้นจนกว่าจะมีการผสานรวม Electron Fiddle ในสัปดาห์ที่ 9-10

1. อัปเดตหน้าที่แสดงรายชื่อที่มีอยู่ทั้งหมดที่ใช้ฟีเจอร์ได้ (ที่สร้างขึ้นระหว่างสัปดาห์ที่ 3) ตามลําดับชั้นใหม่ของตัวอย่าง

สัปดาห์ที่ 6 และ 7 จะมีขึ้นเพื่อถ่ายโอนตัวอย่าง electron-api-demos ไปยังเอกสารหลักตามเทมเพลตที่อธิบายไว้ข้างต้น ขั้นตอนสุดท้าย ควรลบหรือเลิกใช้ที่เก็บ electron-api-demos

สัปดาห์ที่ 8-10

สัปดาห์ที่ 8 จะมุ่งเน้นไปที่การเตรียมเทมเพลต (วิธีหนึ่ง) เพื่อผสานรวม Electron Fiddle ลงในเอกสารหลัก โครงการริเริ่มนี้เกิดขึ้นแล้ว (ตรวจสอบรายละเอียดในฉบับ #20442) โดยชาว Electron และอาสาสมัครของชุมชน แต่ต้องมีการสรุปที่เหมาะสม

หากต้องการดำเนินการต่อกับตัวอย่าง Fiddle เทมเพลตพื้นฐานควรมีลักษณะดังนี้ 1. ดูตัวอย่างจากเอกสารประกอบหลัก (เช่น การเริ่มต้นอย่างรวดเร็ว) ในขณะนี้ เอกสารประกอบควรมีตัวอย่าง electron-api-demos ด้วย 2. สร้างตัวอย่างใหม่ใน Electron Fiddle (โดยใช้โค้ดตัวอย่างหรือซอร์สโค้ดเป็นจุดเริ่มต้น) 3. บันทึกฟิดเดิลลงในโฟลเดอร์ในเครื่อง 4. ย้ายตัวอย่างไปที่ /docs/fiddles/[CATEGORY]/[SECTION]/[DEMO] * รายการตัวอย่างที่สมบูรณ์อธิบายไว้ในส่วน "รายการการสาธิต" ของปัญหา 5. เพิ่มปุ่ม "เปิดใน Fiddle" ตามที่อธิบายในความคิดเห็นเบื้องต้นในปัญหา #2848

สัปดาห์ที่ 9 และ 10 จะมุ่งเน้นการบูรณาการตัวอย่างสาธิตการใช้อิเล็กตรอน API (ซึ่งได้แปลงเป็น Fiddles แล้ว) เข้ากับเอกสารหลักตามเทมเพลตที่อธิบายข้างต้น

สัปดาห์ที่ 11

สัปดาห์นี้อาจจะทุ่มเทให้กับการสรุปโครงการงานเขียนอย่างเต็มที่หลังจากการย้ายที่เก็บ electron-api-demos ในที่เก็บตัวอย่างและตัวอย่าง Electron Fiddle สำเร็จ ซึ่งประกอบด้วย - ตรวจสอบว่าตัวอย่างโค้ดที่มีอยู่ทั้งหมดมีปุ่ม "เปิดในฟิดเดิล" - ตรวจสอบว่าตัวอย่างโค้ดที่มีอยู่ทั้งหมดทำงานได้อย่างถูกต้องในฐานะ Fiddles และตรวจสอบว่าเอกสารหลักไม่ได้อ้างถึงที่เก็บ electron-api-demos อีกต่อไป

สัปดาห์ที่ 12

สรุปงานที่เสร็จสมบูรณ์ การตรวจสอบการยอมรับ