หน้านี้มีรายละเอียดโครงการงานเขียนเชิงเทคนิคที่ได้รับการยอมรับใน Google Season of เอกสาร
สรุปโปรเจ็กต์
- องค์กรโอเพนซอร์ส
- Kolibri
- นักเขียนเชิงเทคนิค
- StephDix
- ชื่อโปรเจ็กต์:
- รูปแบบและรูปแบบเวิร์กโฟลว์ของเอกสารประกอบระบบนิเวศ Kolibri
- ระยะเวลาของโปรเจ็กต์
- ใช้งานนาน (5 เดือน)
คำอธิบายโปรเจ็กต์
บทคัดย่อ
เอกสารนี้แสดงรายละเอียดเกี่ยวกับการนำหลักเกณฑ์ด้านรูปแบบและการจัดการเวิร์กโฟลว์ไปใช้กับข้อมูลที่ Learning Equality สำหรับโครงการระบบนิเวศของ Kolibri
ภาพรวม
ข้อเสนอของเรามี 4 ระยะ ในขั้นแรก เราจะจัดทำคู่มือสไตล์เอกสารประกอบของ LE ให้เสร็จสมบูรณ์พร้อมหลักเกณฑ์การช่วยเหลือพิเศษ การเขียน และคำแนะนำเกี่ยวกับรูปแบบตามแนวคิดและหลักเกณฑ์สไตล์ของ LE ในการพัฒนาซอฟต์แวร์ ในระยะที่ 2 เราจะทำการตรวจสอบคุณภาพเอกสาร ReadTheDocs และ Google เอกสาร แผนการตรวจสอบจะผสานรวมการใช้รายการตรวจสอบเพื่อประเมินการปฏิบัติตามหลักเกณฑ์ด้านสไตล์ รายการตรวจสอบเหล่านี้จะช่วยบันทึกสิ่งที่พบและนําการเปลี่ยนแปลงไปใช้กับเอกสารประกอบ ในเฟสที่ 3 เราจะทํางานเกี่ยวกับโครงสร้าง รูปลักษณ์ และความรู้สึกของเทมเพลตจากเอกสาร ReadTheDocs และ Google เอกสาร เราจะสร้างที่เก็บเทมเพลตและรูปภาพใน Google ไดรฟ์เพื่อระบุหมวดหมู่เทมเพลตแต่ละหมวดหมู่ของประเภทเอกสารหลักเพื่อใช้ซ้ำในการนำไปใช้งานในอนาคต เราจะเสริมงานนี้ด้วยการสร้างเทมเพลตเพื่อส่งปัญหาเกี่ยวกับเอกสารเพื่อให้ระบุได้ง่ายในการตรวจสอบคำขอดึง สุดท้ายนี้ เราจะสร้างคู่มือสำหรับผู้ร่วมให้ข้อมูลซึ่งจะจัดกลุ่มแหล่งข้อมูลที่เป็นประโยชน์สำหรับผู้ทำงานร่วมกันแต่ละกลุ่มเพื่อปรับปรุงประสบการณ์ในการเข้าถึงข้อมูล
วัตถุประสงค์และขอบเขต
แผนการติดตั้งใช้งานนี้มีจุดประสงค์เพื่อปรับปรุงประสบการณ์ของผู้ใช้ปลายทางที่ใช้เอกสารของ Kolibri และช่วยให้สมาชิกในทีมและผู้มีส่วนร่วมสร้างเอกสารประกอบที่ดีขึ้นและทำงานร่วมกันได้อย่างมีประสิทธิภาพในชุมชน การใช้งานนี้มีผลกับ ReadTheDocs และชุดย่อยของเอกสาร Google เอกสารในระบบนิเวศ Kolibri
ผู้ชม
กลุ่มเป้าหมายหลักคือผู้ติดตั้งใช้งาน ผู้ดูแลระบบ และผู้ใช้ปลายทาง ซึ่งเป็นผู้บริโภคที่สำคัญที่สุดของเอกสารประกอบ Kolibri กลุ่มเป้าหมายรองซึ่งเป็นสมาชิกในทีมและผู้ทำงานร่วมกันสำหรับการผลิตและการใช้เอกสารประกอบของ Kolibri
วัตถุประสงค์
คู่มือสไตล์และระบบเวิร์กโฟลว์สำหรับ Kolibri Ecosystem Documentation คาดหวังให้ผู้ใช้: สร้างเอกสารที่เข้าใจง่ายโดยใช้ภาษาที่เข้าถึงได้และเลย์เอาต์ที่สอดคล้องกัน รักษาการบำรุงรักษาแนวทางปฏิบัติด้านคุณภาพในเอกสารประกอบ ทำให้เข้าถึงข้อมูลระหว่างช่องทางเอกสารต่างๆ ได้ง่าย เสริมสร้างโครงการริเริ่มแบบร่วมมือกันในชุมชนโอเพนซอร์สของ Kolibri
แหล่งข้อมูล
แหล่งข้อมูลของฉัน ได้แก่ Kolibri, Kolibri Studio, Kolibri Development RTD และ Kolibri Toolkits จาก Google ไดรฟ์
Radina Matic สุดยอดผู้ดูแลของเราได้ช่วยแนะนำกิจกรรมอุ่นเครื่องและกิจกรรมเฉพาะโปรเจ็กต์ ข้อมูลของเธอเกี่ยวกับสิ่งที่องค์กรเรียกว่า ""หลักเกณฑ์"" และ ""คำแนะนำ"" รวมถึงการมีคู่มือสำหรับผู้มีส่วนร่วมช่วยให้ฉันจัดระเบียบแนวคิดและร่างสรุปได้
ซอฟต์แวร์
เราจะพัฒนาร่างคู่มือสไตล์ใน Google เอกสาร แพลตฟอร์มเอกสารนี้เหมาะอย่างยิ่งสำหรับการปรับปรุงขณะที่พร้อมเผยแพร่ สำหรับการตรวจสอบ QA เราจะใช้ Google ฟอร์มเพื่อดำเนินการและประเมินเอกสาร สเปรดชีตจะเก็บคำตอบของแบบฟอร์มสำหรับการควบคุมเอกสาร เราจะเปลี่ยนรูปแบบเอกสาร RTD โดยใช้ GitHub ฉันเคยใช้ Git, Gitkraken, GitHub และ Gitlab แล้ว ฉันมีความรู้เกี่ยวกับ Markdown และ RestructuredText เล็กน้อย เราวางแผนที่จะมีส่วนร่วมในการแก้ไขเอกสารประกอบเพื่อเรียนรู้ไวยากรณ์ต่อไป ฉันจะใช้ Sharex สำหรับรูปภาพและ GIF เราชอบเครื่องมือนี้เพราะแสดงผลในรูปแบบเอาต์พุตต่างๆ ฉันจะใช้ Diagrams ในการทำแผนภาพและแก้ไขรูปภาพ ซอฟต์แวร์แผนภาพผสานรวมกับ Google เอกสาร, Google ไดรฟ์ และ LibreOffice ได้อย่างลงตัว สถานะเอกสารประกอบ ในระยะการสํารวจ เราได้แก้ไขเอกสารประกอบส่วนใหญ่ของ Kolibri เราพบข้อผิดพลาดทางไวยากรณ์ คำที่พิมพ์ผิด ความไม่สอดคล้องในเลย์เอาต์ การจัดรูปแบบตัวอักษร การใช้รูปภาพ และเส้นทางเอกสารที่ทำให้เกิดความสับสนจากเอกสารประกอบส่วนใหญ่ของโปรเจ็กต์ เช่น ในคู่มือผู้ใช้ของ Kolibri ส่วนการแก้ปัญหาจะเป็นหัวข้อย่อย ไม่ใช่หัวข้อ ข้อมูลนี้มีความสำคัญมากพอที่ผู้ใช้ปลายทางจะเข้าถึงได้จากสารบัญ หรือจะใช้แถบค้นหาและโครงสร้างสารบัญเพื่อขยายหัวข้ออื่นๆ และค้นหาบทความการแก้ปัญหาก็ได้
หากต้องการเข้าถึงส่วน "การแก้ปัญหา" คุณต้องค้นหาส่วนดังกล่าวหรือขยาย "จัดการ Kolibri" เพื่อดูว่าการแก้ปัญหาเป็นส่วนหนึ่งของเอกสารประกอบ คู่มือกับหลักเกณฑ์ สําหรับโปรเจ็กต์นี้ เราได้วิเคราะห์เอกสาร 2 รายการ ได้แก่ คู่มือสไตล์เอกสารประกอบสําหรับผู้ใช้ LE Kolibri และหลักเกณฑ์การแปล LE ในคู่มือ LE Kolibri Guide ฉันได้ให้คำแนะนำและความคิดเห็นจากโครงร่างหัวข้อที่เสนอและแผนเอกสารประกอบ รวมถึงอีก 2-3 อย่างที่ต้องปรับปรุงในคำแนะนำ สำหรับหลักเกณฑ์การแปล LE เราได้เปลี่ยนรูปแบบและสไตล์ตามคำแนะนำและแบบแผนที่มีอยู่ของคู่มือสไตล์ สิ่งที่เราสังเกตเห็นมากที่สุดระหว่างการวิเคราะห์คือความเข้าใจผิดเกี่ยวกับเอกสารที่จัดหมวดหมู่เป็นคู่มือและหลักเกณฑ์
ผลลัพธ์
ฉันได้ตรวจสอบคุณภาพใน LE Translation Guide เพิ่มเติมจากคําแนะนําและความคิดเห็นโดยใช้แบบฟอร์มเบื้องต้นซึ่งได้อธิบายไว้อย่างละเอียดในงานการตรวจสอบ QA ความคิดเห็นสุดท้ายที่ได้รับจากการประเมินมีดังนี้ ลิงก์เสียสำหรับเว็บไซต์ ICU ไวยากรณ์ .js รูปแบบที่ใช้สร้างหลักเกณฑ์เหล่านี้ไม่ถูกต้อง เอกสารเป็นคู่มือ ไม่ใช่หลักเกณฑ์ การจัดรูปแบบตัวอักษรไม่สอดคล้องกัน ใช้ส่วนหัวและชื่ออย่างไม่ถูกต้อง ใช้ภาษาไม่เหมาะสมและใช้คําย่ออย่างไม่ถูกต้อง การใช้ข้อความสำรองที่ไม่เหมาะสม คำสั่ง/ วิธีการที่ซ้ำกันมากเกินไป
ผลการวิจัยของทั้ง 2 เอกสารเป็นส่วนหนึ่งของสิ่งที่ส่งมอบสำหรับข้อเสนอนี้
งานเฉพาะโปรเจ็กต์
- คําแนะนําเกี่ยวกับคู่มือสไตล์ของเอกสารประกอบสําหรับผู้ใช้ LE (ความคิดเห็น)
- หลักเกณฑ์การแปล LE ที่มีรูปแบบและสไตล์ใหม่
- เค้าโครงหัวข้อ
- ไทม์ไลน์ของโปรเจ็กต์
- งานด้านเอกสารประกอบ