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