โปรเจ็กต์โครงสร้างพื้นฐานของคอมไพเลอร์ LLVM

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

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

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

โครงสร้างพื้นฐานคอมไพเลอร์ LLVM

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

DR87

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

ปรับโครงสร้างดัชนีเอกสารประกอบ LLVM และคู่มือสไตล์เอกสารประกอบ

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

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

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

โปรเจ็กต์นี้ประกอบด้วยงานต่อไปนี้

a.) ปรับโครงสร้างหน้าดัชนีเอกสารใหม่เพื่อมอบประสบการณ์การใช้งานที่ใช้ง่ายยิ่งขึ้น งานนี้จะเกี่ยวข้องกับการประเมินหน้าปัจจุบันและการจัดโครงสร้างใหม่โดยอิงตามการวิจัยอิสระ การสัมภาษณ์ SME และความคิดเห็นของผู้ใช้ ตัวเลือกที่เป็นไปได้ ได้แก่ การแก้ไขคำอธิบายสั้นๆ การปรับโครงสร้างหน้าเว็บที่มีอยู่ และ/หรือการเพิ่มเลเยอร์ (หน้าเว็บ) เพิ่มเติมผ่านรูปแบบการเปิดเผยข้อมูลแบบเป็นขั้นๆ การดำเนินการแบบหลังจะลดจำนวนลิงก์ในหน้าดัชนีหลักเพื่อให้ผู้ใช้ค้นหาข้อมูล/คำแนะนำที่เฉพาะเจาะจงได้ง่ายขึ้น เช่น ดัชนีอาจมีลิงก์ไปยังหน้าแยกต่างหากสำหรับการออกแบบและภาพรวมของ LLVM, คู่มือผู้ใช้, เอกสารประกอบเกี่ยวกับระบบย่อย และเอกสารประกอบเกี่ยวกับกระบวนการพัฒนา

b.) อัปเดตคู่มือสไตล์ LLVM Sphinx สำหรับผู้ร่วมให้ข้อมูลแบบโอเพนซอร์ส ซึ่งงานนี้จะรวมถึงการประเมินคู่มือปัจจุบัน การระบุช่องโหว่ผ่านการวิจัยอิสระและการสัมภาษณ์ SME และการอัปเดตคู่มือตามข้อกำหนดที่ตกลงกันไว้ การอัปเดตอาจรวมถึงการจัดระเบียบเลย์เอาต์ของคู่มือใหม่ การเพิ่มเนื้อหาใหม่ และแทรกลิงก์ไปยังหน้าที่เกี่ยวข้อง เช่น คู่มือสำหรับผู้มีส่วนร่วม โดยมีเป้าหมายเพื่อให้อาสาสมัครเริ่มให้ความช่วยเหลือโดยเร็วที่สุดได้ง่ายขึ้น