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

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

ข้อมูลสรุปของโปรเจ็กต์

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

เปิดคอลเล็กชัน

ผู้เขียนด้านเทคนิค:

Anna e Só

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

26-27 กันยายน: การพิสูจน์แนวคิดของเราต้องมีการปรับเปลี่ยนใดๆ ก่อนที่จะถ่ายทอดสดไหม คุณต้องการเวลามากกว่านี้ไหม แล้วปรับให้เหมาะสม (รายงานที่ 6)

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

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

16-20 ตุลาคม: ช่วงสั้นๆ จากการทำกิจกรรม [1]

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

อาจมีการขยายเวลาของโปรเจ็กต์ตามคำขอ

[1]: วางแผนการเดินทางก่อนการสมัครเอกสารในฤดูกาลแข่งขัน

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