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