โปรเจ็กต์ FOLIO

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

สรุปโปรเจ็กต์

องค์กรโอเพนซอร์ส
FOLIO
นักเขียนเชิงเทคนิค:
gallinita
ชื่อโปรเจ็กต์:
การขยายเอกสารประกอบสำหรับผู้ใช้ปลายทางของแอป FOLIO
ระยะเวลาของโปรเจ็กต์
ใช้งานนาน (5 เดือน)

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

สำหรับโปรเจ็กต์นี้ เราวางแผนที่จะสร้างและอัปเดตเอกสารประกอบ FOLIO ที่มุ่งเป้าไปยังผู้ใช้ปลายทาง เนื่องจาก FOLIO เป็นระบบการจัดการห้องสมุด ผู้ใช้ปลายทางจึงเป็นเจ้าหน้าที่ห้องสมุด ปัจจุบันวิกิของ FOLIO (https://wiki.folio.org/) มีเอกสารประกอบบางส่วน แต่มีเพียงเล็กน้อยและไม่ได้อยู่ในรูปแบบที่อ่านง่ายซึ่งจัดทำขึ้นโดยคำนึงถึงเจ้าหน้าที่ห้องสมุด เอกสารประกอบใหม่ที่สร้างขึ้นจากโปรเจ็กต์นี้จะโฮสต์ฐานความรู้ด้านเอกสารประกอบที่เฉพาะเจาะจง ซึ่งเข้าถึงได้จากแอปของ FOLIO และมีเวิร์กโฟลว์ที่เกี่ยวข้องกับระบบและผู้ใช้ไลบรารี เราจะเผยแพร่ชุดเอกสารประกอบชุดแรกในเว็บไซต์ โดยเริ่มจากฟังก์ชันการยืมและสำรองหลักสูตร ฉันต้องการมีส่วนร่วมในเอกสารประกอบให้มากที่สุดตลอดระยะเวลาของโปรเจ็กต์ "ระยะยาว" นี้

เมื่อตรวจสอบโปรเจ็กต์เอกสารประกอบของ FOLIO เราได้พูดคุยกับ Marcia Borensztajn เกี่ยวกับความต้องการและสถานการณ์เอกสารประกอบปัจจุบันของ FOLIO ดังที่กล่าวไว้ข้างต้น เอกสารของ FOLIO ต้องได้รับการปรับปรุง ขยาย และปรับปรุงใหม่เพื่อให้ช่วยเหลือผู้ใช้ได้สำเร็จ จำเป็นต้องสร้างเอกสารประกอบเพื่อจำลองกระบวนการของไลบรารีมาตรฐาน และเนื่องจาก FOLIO ประกอบด้วย "แอป" ต่างๆ ที่ทำงานร่วมกัน จึงต้องมีการอธิบายระบบโดยรวม ในฐานะบรรณารักษ์ เราคุ้นเคยกับสถานการณ์และเวิร์กโฟลว์ประเภทต่างๆ ที่ผู้ใช้ FOLIO อาจจะพบและต้องการความช่วยเหลือ Marcia กำลังสร้างฐานความรู้ของเอกสารประกอบใหม่โดยใช้ Markdown, Git และ Hugo จากโปรเจ็กต์นี้ เราจะสร้างเอกสารประกอบใหม่เกี่ยวกับ FOLIO เพื่อเป็นเฟรมเวิร์กสำหรับอนาคต