หน้านี้มีรายละเอียดของโครงการการเขียนเชิงเทคนิคที่ยอมรับสำหรับ Google Season of Docs
ข้อมูลสรุปของโปรเจ็กต์
- องค์กรโอเพนซอร์ส:
- HPX
- ผู้เขียนด้านเทคนิค:
- rstobaugh
- ชื่อโปรเจ็กต์:
- แก้ไขและปรับปรุงเอกสารประกอบเกี่ยวกับ HPX ที่มีอยู่
- ระยะเวลาของโปรเจ็กต์:
- ระยะเวลามาตรฐาน (3 เดือน)
คำอธิบายโปรเจ็กต์
ข้อเสนอของผมคือการแก้ไขและปรับปรุงเนื้อหาของเอกสาร HPX ที่มีอยู่ ข้อเสนอของฉันมีไว้สำหรับโครงการระยะเวลามาตรฐาน (3 เดือน) ซึ่งเน้นการแก้ไขบท 2 บทของ STE||คู่มือของกลุ่ม HPX: ""ระบบการสร้างและการเปิดตัว HPX"" (1) และ ""การกำหนดค่าแอปพลิเคชัน HPX"" (2)
บทในเรื่อง ""ระบบการสร้างและการเปิดตัว HPX"" มีข้อผิดพลาดทางไวยากรณ์หลายอย่าง และยังมีภาษาที่สับสนและการใช้อักษรตัวพิมพ์ใหญ่อย่างไม่สอดคล้อง เช่น "CMake" นอกจากนี้ ยังมีข้อมูลซ้ำๆ ซึ่งฉันวางแผนที่จะจัดเรียงใหม่ รวม และตัดออกตามความจำเป็น แม้ว่าบท "การกำหนดค่าแอปพลิเคชัน HPX" ยังมีข้อผิดพลาดทางไวยากรณ์ที่ต้องแก้ไข แต่ข้อกังวลหลักของฉันสำหรับบทนี้คือความเป็นมิตรกับผู้ใช้ บทมีปัญหาเรื่องการออกแบบหลักๆ 3 ประการที่ฉันวางแผนจะแก้ไข:
บางหัวข้ออาจฝังอยู่ในข้อความ ซึ่งทำให้อ่านบทต่างๆ ได้ยาก ปัจจุบัน ผู้ใช้ต้องอ่านคู่มืออย่างละเอียดเพื่อให้เข้าใจจุดประสงค์ของแต่ละตาราง นี่ไม่ใช่วิธีที่ผู้ใช้ส่วนใหญ่โต้ตอบกับคู่มือการสอน โดยเฉพาะหากผู้ใช้เคยอ่านเนื้อหามาก่อนแล้ว แต่ฉันวางแผนที่จะดูให้แน่ใจว่าแต่ละตารางมีส่วนหัวที่ชัดเจนและแตกต่างกัน ซึ่งทำให้มองเห็นได้ง่ายหากผู้ใช้เลื่อนผ่านข้อความ
เมื่อแสดงรายการคุณสมบัติต่างๆ ภายใต้ส่วนหัวหนึ่ง คุณสมบัติจะไม่เรียงตามลำดับที่สมเหตุสมผล แม้ว่าพร็อพเพอร์ตี้ต่างๆ จะได้รับการจัดกลุ่มให้อยู่ในธีมเดียวกัน แต่ก็ไม่มีการจัดกลุ่มย่อยซึ่งทำให้ข้อมูลกระจัดกระจาย ตัวอย่างเช่น ผู้ใช้รายหนึ่งอาจพบอสังหาริมทรัพย์หลายแห่งที่เกี่ยวข้องกับย่าน บางแห่งเกี่ยวข้องกับอีกเรื่องหนึ่ง และติดต่อกับอีกพื้นที่หนึ่งที่เกี่ยวข้องกับย่าน การขาดโครงสร้างภายในภายใต้ส่วนหัวนี้ทำให้การค้นหาข้อมูลทั้งหมดในหัวข้อย่อยหนึ่งๆ เป็นไปได้ยากขึ้น ดังนั้น เราจึงวางแผนที่จะจัดระเบียบแผนภูมิต่างๆ ใหม่เพื่อให้จัดกลุ่มข้อมูลที่คล้ายกันไว้ด้วยกันได้ชัดเจนยิ่งขึ้นภายใต้แต่ละหัวข้อ
ผู้ใช้จะต้องเลื่อนไปมาระหว่างส่วนต่างๆ (หรือเปิดคู่มือในแท็บแยกกัน 2 แท็บ) เพื่อทำความเข้าใจคำสั่งบางอย่างอย่างละเอียด มีจุดต่างๆ ที่บทจะนำผู้ใช้ไปยังประโยคเดียวภายในส่วนก่อนหน้าในลักษณะที่บังคับให้ผู้อ่านเลื่อนขึ้นหรือไปที่ไฮเปอร์ลิงก์เพื่อทำความเข้าใจคำสั่งจริงๆ เนื่องจากคู่มือใช้ภาษาที่คลุมเครือ เช่น "ขั้นตอนนี้สร้างขึ้นหลังจากขั้นตอนที่ 11" ในส่วนก่อนหน้า แม้ว่าวิธีนี้จะกำจัดการกล่าวซ้ำออกไปได้ แต่ก็ทำให้การทำความเข้าใจวิธีการนั้นยากขึ้น เนื่องจากงานเหล่านี้ต้องทำตามลำดับเฉพาะ แต่ขอเสนอให้เพิ่มคำที่เจาะจงมากขึ้น เพื่อให้ผู้ใช้ไม่ต้องขัดจังหวะขั้นตอนการอ่านด้วยการสลับระหว่างส่วนหรือเอกสาร
หากกรอกข้อมูลในส่วนเหล่านี้เสร็จก่อนไทม์ไลน์มาตรฐานจะเสร็จ ฉันต้องล้างข้อมูลในหน้า "ทำไมต้องเป็น HPX" (3) ใต้เอกสารประกอบผู้ใช้ของกลุ่ม STE||AR หน้านี้มีเนื้อหาส่วนแนะนําซ้ำๆ ซึ่งเราหวังว่าจะรวมเข้าด้วยกันได้ และมีการใช้อักษรตัวพิมพ์ใหญ่ (โดยเฉพาะศัพท์เฉพาะ) ที่ไม่สอดคล้องกัน ทําให้รู้สึกไม่แบ่งแยก เป้าหมายของผมคือการแนะนำงานของกลุ่ม STE||AR ที่เป็นหนึ่งเดียวและสอดคล้องกันมากขึ้น