หน้านี้มีรายละเอียดของโครงการการเขียนเชิงเทคนิคที่ยอมรับสำหรับ Google Season of Docs
ข้อมูลสรุปของโปรเจ็กต์
- องค์กรโอเพนซอร์ส:
- FOLIO
- ผู้เขียนด้านเทคนิค:
- gallinita
- ชื่อโปรเจ็กต์:
- การขยายเอกสารประกอบสำหรับผู้ใช้ปลายทางเกี่ยวกับแอป FOLIO
- ระยะเวลาของโปรเจ็กต์:
- วิ่งเป็นเวลานาน (5 เดือน)
คำอธิบายโปรเจ็กต์
ฉันวางแผนที่จะสร้างและอัปเดตเอกสาร FOLIO ที่กำหนดเป้าหมายเป็นผู้ใช้ปลายทางสำหรับโปรเจ็กต์นี้ เนื่องจาก FOLIO เป็นระบบการจัดการห้องสมุด ผู้ใช้ปลายทางจึงเป็นเจ้าหน้าที่ห้องสมุด ปัจจุบัน FOLIO wiki (https://wiki.folio.org/) มีเอกสารประกอบจำนวนหนึ่ง แต่มีขนาดเล็กและไม่ได้อยู่ในรูปแบบที่เข้าใจได้ง่ายซึ่งสร้างขึ้นโดยคำนึงถึงเจ้าหน้าที่ห้องสมุด เอกสารใหม่ที่สร้างขึ้นจากโปรเจ็กต์นี้จะโฮสต์บนฐานความรู้เอกสารที่เจาะจงซึ่งเข้าถึงได้จากแอปของ FOLIO และมีเวิร์กโฟลว์ที่เกี่ยวข้องกับระบบและผู้ใช้ไลบรารีของระบบ ระบบจะเผยแพร่ชุดเอกสารประกอบเริ่มต้นในเว็บไซต์ โดยเริ่มจากฟังก์ชันการเผยแพร่และการจองหลักสูตร ฉันต้องการมีส่วนร่วมมากที่สุดเท่าที่จะทำได้ในเอกสารประกอบตลอดระยะเวลาของโปรเจ็กต์ "ระยะยาว" นี้
จากการพิจารณาโครงการเอกสารของ FOLIO เราได้พูดคุยกับ Marcia Borensztajn เกี่ยวกับความต้องการของ FOLIO และสถานการณ์เอกสารในปัจจุบัน ดังที่กล่าวไว้ข้างต้น เอกสาร FOLIO ต้องมีการอัปเดต ขยาย และปรับปรุงใหม่เพื่อให้ช่วยเหลือผู้ใช้ได้สำเร็จ จำเป็นต้องสร้างเอกสารให้เหมือนกับกระบวนการไลบรารีมาตรฐาน และเนื่องจาก FOLIO ประกอบด้วย "แอป" ต่างๆ ที่ทำงานร่วมกัน ระบบจึงต้องอธิบายทั้งระบบ เนื่องจากฉันเป็นบรรณารักษ์ ฉันจึงคุ้นเคยกับสถานการณ์และเวิร์กโฟลว์ประเภทต่างๆ ที่ผู้ใช้ของ FOLIO น่าจะพบและต้องการความช่วยเหลือ มัลลิกากำลังสร้างฐานความรู้ใหม่เกี่ยวกับเอกสารประกอบโดยใช้มาร์กดาวน์, Git และ Hugo จากโปรเจ็กต์นี้ ระบบจะสร้างเอกสารประกอบใหม่เกี่ยวกับ FOLIO และทำหน้าที่เป็นเฟรมเวิร์กสำหรับอนาคต