หน้านี้มีรายละเอียดของโครงการการเขียนเชิงเทคนิคที่ยอมรับสำหรับ Google Season of Docs
ข้อมูลสรุปของโปรเจ็กต์
- องค์กรโอเพนซอร์ส:
- ภาษาของจูเลีย
- ผู้เขียนด้านเทคนิค:
- Sophb
- ชื่อโปรเจ็กต์:
- การพัฒนาเว็บไซต์ FluxML ขึ้นมาใหม่
- ระยะเวลาของโปรเจ็กต์:
- ระยะเวลามาตรฐาน (3 เดือน)
คำอธิบายโปรเจ็กต์
ข้อเสนอนี้มีเป้าหมายเพื่อปรับปรุงเว็บไซต์เอกสารประกอบของ Flux เพื่อให้ข้อมูลที่มีมีโครงสร้างและน่าสนใจสำหรับผู้มาใหม่และผู้เชี่ยวชาญ กล่าวอย่างเจาะจงก็คือ เป้าหมายคือการจัดระเบียบใหม่ในเอกสารที่มีอยู่ให้เป็นส่วนๆ ใหม่ และสร้างบทแนะนำการเริ่มต้นใช้งานใหม่สำหรับผู้มาใหม่ที่ขยายบทแนะนำ Flux 60-Minor-blitz
โครงการประกอบด้วยระยะต่างๆ ต่อไปนี้
วิเคราะห์เว็บไซต์เอกสารประกอบปัจจุบัน: ตรวจสอบข้อมูลที่มีอยู่และกำหนดคู่มือสไตล์ (สำหรับข้อมูล) สำหรับการสร้างบทแนะนำใหม่
กำหนดโครงสร้างใหม่สำหรับข้อมูลและบทแนะนำการเริ่มต้นใช้งาน: ทำงานร่วมกับ Mentor เพื่อกำหนดส่วนต่างๆ ใหม่และการจัดระเบียบเว็บไซต์เอกสารใหม่ นอกจากนี้ ให้กำหนดสารบัญสำหรับบทแนะนำการเริ่มต้นใช้งานโดยใช้บทแนะนำ Flux 60-mine-blitz เป็นจุดเริ่มต้นและต่อยอดจากบทแนะนำนี้
ปรับโครงสร้างข้อมูล: อัปเดตเว็บไซต์ตามแผนที่วางไว้ในความร่วมมือกับที่ปรึกษาในขั้นตอนก่อนหน้า
สร้างบทแนะนำเพื่อเริ่มต้นใช้งาน: เขียนฉบับร่างแรกและทบทวน รับฟังความคิดเห็นจากที่ปรึกษา เมื่อที่ปรึกษาและเราเห็นว่าเรามีเอกสารฉบับสุดท้ายแล้ว เราจะเผยแพร่เอกสารนี้ในเว็บไซต์เอกสารประกอบ
(ไม่บังคับ) แปลงเอกสารที่มีอยู่ให้เป็นรูปแบบ README เป็น HTML: หากฉันมีเวลาเหลือหลังจากดำเนินการทั้ง 4 ระยะหลักๆ เสร็จแล้ว เราจะสามารถแปลงบทแนะนำที่มีอยู่ซึ่งเป็น README เพื่อให้เข้าถึงเนื้อหาเหล่านั้นจากเว็บไซต์ได้ง่ายขึ้น
เพื่อให้บรรลุเป้าหมายของโครงการนี้ เราจะประสานงานกับชุมชน Flux อย่างใกล้ชิดเพื่อทำความเข้าใจเอกสารประกอบที่มีอยู่และกำหนดแนวทางที่ดีที่สุด ฉันเพิ่งรู้จัก Julia และฉันเชื่อว่าข้อมูลนี้จะมีประโยชน์อย่างมากในการกำหนดระดับของข้อมูลที่เหมาะสมสำหรับบทแนะนำการเริ่มต้นใช้งานแบบใหม่
ฉันจะเน้นตรวจสอบให้แน่ใจว่าผลงานของฉันช่วยให้ชุมชน Flux เริ่มต้นใช้งานการใช้งานใหม่ๆ ได้ นอกจากนี้ ฉันจะเน้นช่วยให้ผู้ใช้ที่มีประสบการณ์ค้นพบกรณีการใช้งานใหม่ๆ และสำรวจรายละเอียดของ Flux