เปิดโปรเจ็กต์แบบรวม

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

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

องค์กรโอเพนซอร์ส

Open Collective

นักเขียนเชิงเทคนิค

Anna e só

ชื่อโปรเจ็กต์:

ปรับปรุงเอกสารความช่วยเหลือทั่วไป

ระยะเวลาของโปรเจ็กต์

ระยะเวลามาตรฐาน (3 เดือน)

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

ความประทับใจแรก เป็นเรื่องปกติที่จะพบหน้าเอกสารประกอบซึ่งมีวิธีการที่ไม่มีสื่อที่รองรับ (วิดีโอ, GIF, รูปภาพ) ในขณะที่ส่วนอื่นๆ ในบทเดียวกันมีรายการที่สมบูรณ์มากกว่า ตัวอย่างเช่น Edit Collective จะประกอบด้วยวิธีการก็ต่อเมื่อ Add Fiscal Host ประกอบด้วยสื่อสนับสนุนเท่านั้น

ในหน้าเว็บที่ฉันเรียกดู ไม่มีคำอธิบายสื่อโดยใช้แอตทริบิวต์ข้อความแสดงแทน การไม่มีคำอธิบายรูปภาพจะส่งผลต่อความเข้าใจเอกสารอย่างสมบูรณ์สำหรับผู้ที่ใช้โปรแกรมอ่านหน้าจอและผู้ที่มีการเชื่อมต่ออินเทอร์เน็ตช้าซึ่งอาจทำให้โหลดสื่อไม่สำเร็จ

ส่วนต่างๆ ของเอกสารประกอบจะรวมคําถามที่พบบ่อยและวิธีการโดยตรงในการไปยังส่วนต่างๆ ของอินเทอร์เฟซผู้ใช้ เช่น เปลี่ยนโฮสต์ด้านการเงิน เนื่องจากไม่มีสารบัญในอินเทอร์เฟซเอกสารประกอบ ผู้ใช้ที่ทราบถึงผลที่ตามมาของการเปลี่ยนแปลงในระเบียนการจดทะเบียนและต้องการเพียงวิธีการที่เป็นกลางอาจรู้สึกว่าเอกสารประกอบมีรายละเอียดมากเกินไปและไม่ได้ตรงประเด็น

แม้ว่าภาษาของเอกสารประกอบทางเทคนิคจะค่อนข้างสอดคล้องกัน แต่เอกสาร Style Guide ที่เผยแพร่ต่อสาธารณะน้อยเกินไปเกี่ยวกับวิธีเขียนเอกสารประกอบ เนื่องจากหน้าการมีส่วนร่วมพูดถึงการมีส่วนร่วมในเอกสารประกอบทางเทคนิค ทั้ง Open Collective และผู้มีส่วนร่วมที่อาจเกิดขึ้นจะได้รับประโยชน์จากหลักเกณฑ์ที่ครอบคลุมมากขึ้น

แนวทาง เราขอเสนอให้มีการตรวจสอบหน้าความช่วยเหลือของผู้ใช้ โดยพิจารณาการนำเสนอและโครงสร้างปัจจุบันใหม่

วิธีการและลำดับเวลา ฉันต้องการปรับปรุงเอกสารประกอบของ Open Collective โดยทำงานร่วมกับชุมชนเพื่อส่งเสริมวงจรการให้ความคิดเห็นอย่างต่อเนื่องในระยะเวลาที่หลากหลาย

ระยะเวลาทำความรู้จักกับชุมชน (1 สิงหาคม - 1 กันยายน 2019): ทำความรู้จักกับชุมชน Open Collective สัมภาษณ์สมาชิกที่ใช้งานอยู่จากโปรเจ็กต์ที่โดดเด่นและโปรเจ็กต์ที่เพิ่งเริ่มต้น โดยถามคำถามเกี่ยวกับสถานะปัจจุบันของเอกสารประกอบ (รายงาน #1) จดบันทึกระบบภายในทั้งหมดที่ใช้ติดตามคําถามและปัญหา รวมถึงกระบวนการบันทึกไว้ในเอกสารกลุ่มที่เปิด (รายงาน #2) การประเมินปัญหาแฝงในเอกสารเวอร์ชันปัจจุบันและการเตรียมแผนเพื่อแก้ปัญหา (รายงาน #3)

2-6 กันยายน: วงจรความคิดเห็นและการปรับเปลี่ยนครั้งแรก โดยพิจารณาจากความคิดเห็นและคำแนะนำทั้งหมดที่ชุมชนเสนอในระหว่างระยะเวลาการสานสัมพันธ์ของชุมชน แผนของเราพร้อมใช้งานแล้วใช่ไหม มีสิ่งใดที่จำเป็นต้องเปลี่ยนแปลงเกี่ยวกับเรื่องนี้ไหม (รายงาน #4)

9-20 กันยายน: การพัฒนาการพิสูจน์แนวคิดด้วยบทที่มีประชากรน้อยในเอกสาร ฉบับร่างของคู่มือสไตล์สาธารณะ (รายงาน #5)

23-25 กันยายน: ส่งการพิสูจน์แนวคิดเพื่อรับการประเมิน (กลุ่มปิด)

26-27 กันยายน: Proof of Concept ของเราต้องมีการปรับแก้ใดๆ ก่อนเผยแพร่ไหม เราต้องใช้เวลาเพิ่มไหม ปรับให้เหมาะสม (รายงาน #6)

30 กันยายน - 9 ตุลาคม: การพิสูจน์แนวคิดพร้อมใช้งาน ความคิดเห็นรอบที่ 2 (กลุ่มสาธารณะ)

10-15 ตุลาคม: การประเมินและรอบการปรับค่าใช้จ่ายใน Proof of Concept ครั้งสุดท้าย (รายงาน #7)

16-20 ตุลาคม: หยุดพักกิจกรรมชั่วคราว [1]

21 ตุลาคม - 23 พฤศจิกายน: Public Style Guide สิ้นสุดการให้บริการแล้ว (รายงาน #8) การใช้วิธีการทั้งหมดที่มีอยู่ในคู่มือสไตล์กับหน้าเอกสารประกอบผู้ใช้ทั้งหมด (รายงาน #9) รายงานการประเมินกิจกรรมทั้งหมดที่ดำเนินการและคำแนะนำเพิ่มเติมสำหรับชุมชน (รายงาน #10)

ระยะเวลาของโปรเจ็กต์อาจขยายได้ตามคำขอ

[1]: การเดินทางที่วางแผนไว้ก่อนสมัครเข้าร่วม Season of Docs

สิ่งที่ส่งมอบ - รายงานสาธารณะ 10 ฉบับเกี่ยวกับกิจกรรมที่ดำเนินการ - คู่มือรูปแบบสาธารณะที่ทั้ง Open Collective และผู้มีส่วนร่วมภายนอกสามารถใช้ได้ - หน้าเอกสารสำหรับผู้ใช้ที่ปรับปรุงใหม่