หน้านี้มีรายละเอียดของโครงการเขียนเชิงเทคนิคที่ยอมรับใน Google Season of Docs
ข้อมูลสรุปของโปรเจ็กต์
- องค์กรโอเพนซอร์ส:
- moja ทั่วโลก
- ผู้เขียนด้านเทคนิค:
- แอนโธนี่
- ชื่อโปรเจ็กต์:
- เอกสารเกี่ยวกับโค้ดเครื่องมือการรายงาน
- ระยะเวลาของโปรเจ็กต์:
- ระยะเวลามาตรฐาน (3 เดือน)
คำอธิบายโปรเจ็กต์
เนื่องจากเมื่อมีโอกาสได้บันทึกเครื่องมือการรายงานสำหรับองค์กร Moja Global ผมจึงเสนอที่จะพัฒนาเอกสารประกอบ 6 ประเภทที่กลุ่มเป้าหมายต่างๆ จะใช้เพื่อบรรลุวัตถุประสงค์ที่แตกต่างกัน สรุปได้ดังนี้
1) คู่มือการตั้งค่าสภาพแวดล้อม
1.1) วิศวกรระบบ สำหรับกลุ่มเป้าหมาย
1.2) วัตถุประสงค์ในการช่วยวิศวกรระบบในการตั้งค่าสภาพแวดล้อมการสร้างและการทำงานในเครื่องสำหรับเครื่องมือการรายงาน
1.3) รูปแบบ บทความแสดงวิธีการที่กำหนดชุดขั้นตอนตามลำดับที่วิศวกรระบบต้องทำเพื่อตั้งค่าสภาพแวดล้อมที่เอื้อต่อการสร้างและการทำงานของเครื่องมือการรายงาน
2) คู่มือการสร้าง
2.1) วิศวกรระบบ สำหรับกลุ่มเป้าหมาย
2.2) วัตถุประสงค์ในการช่วยให้วิศวกรระบบสร้างองค์ประกอบเครื่องมือการรายงานจากซอร์สโค้ด
2.3) รูปแบบ บทความแสดงวิธีการที่กำหนดชุดขั้นตอนตามลำดับที่วิศวกรระบบต้องทำเพื่อรับและรวบรวมซอร์สโค้ดของเครื่องมือการรายงาน
3) คู่มือการติดตั้ง
3.1) วิศวกรระบบ สำหรับกลุ่มเป้าหมาย
3.2) วัตถุประสงค์ในการช่วยให้วิศวกรระบบติดตั้งองค์ประกอบของเครื่องมือการรายงานที่สร้างขึ้นใหม่
3.3) รูปแบบ บทความแสดงวิธีการที่กำหนดชุดขั้นตอนตามลำดับที่วิศวกรระบบต้องทำเพื่อติดตั้งใช้งานเครื่องมือการรายงานในสภาพแวดล้อมการตั้งค่าใหม่
4) คู่มือการดำเนินการ
4.1) เครื่องมือรวมระบบ ผู้ชมเป้าหมาย
4.2) วัตถุประสงค์เพื่อช่วยให้วิศวกรระบบสามารถเรียกใช้อินสแตนซ์เครื่องมือการรายงานที่ติดตั้งใหม่
4.3) รูปแบบ บทความวิธีการที่กำหนดชุดขั้นตอนตามลำดับที่ผู้รวมระบบต้องทำในการอัปโหลดและประมวลผลฐานข้อมูลเอาต์พุต Flux บนอินสแตนซ์เครื่องมือการรายงานที่ทำงานอยู่
คู่มือการดำเนินการ เริ่มต้นใช้งานและประมวลผลฐานข้อมูลเอาต์พุต Flux ในเครื่องมือการรายงาน
5) คู่มือผู้ใช้
5.1) ผู้ใช้ปลายทาง ที่เป็นกลุ่มเป้าหมาย
5.2) วัตถุประสงค์ ช่วยให้ผู้ใช้ปลายทางเข้าใจฟีเจอร์ต่างๆ ที่ฝังอยู่ในเครื่องมือการรายงาน และวิธีที่ควรใช้ฟีเจอร์เหล่านี้
5.3) รูปแบบ บทความแสดงวิธีการที่กำหนดชุดขั้นตอนตามลำดับที่ผู้ใช้ปลายทางต้องทำเพื่อใช้ฟังก์ชันของเครื่องมือการรายงานอย่างเหมาะสม
6) คู่มือการพัฒนา
6.1) โปรแกรมเมอร์ กลุ่มเป้าหมาย
6.2) วัตถุประสงค์ ช่วยให้ผู้ใช้ปลายทางเข้าใจฟีเจอร์ต่างๆ ที่ฝังอยู่ในเครื่องมือการรายงาน และวิธีที่ควรใช้ฟีเจอร์เหล่านี้
6.3) รูปแบบ บทความอ้างอิงที่อธิบาย: ก) องค์ประกอบการออกแบบที่สำคัญซึ่งเป็นส่วนประกอบของเครื่องมือ ข) การแยกการทำงานขององค์ประกอบข้างต้น ค) องค์ประกอบการดำเนินการขององค์ประกอบที่แยกส่วนตามฟังก์ชันการทำงาน ง) ซอร์สโค้ด / การจัดระเบียบเครื่องมือ จ) วิสัยทัศน์และทิศทางในระยะยาวสำหรับการปรับปรุงอย่างต่อเนื่อง ฉ) ด้านถัดไปเชิงตรรกะเพื่อการปรับปรุง
และบทแนะนำสั้นๆ ที่อธิบายวิธีการปรับโค้ดให้เหมาะกับสถานการณ์ที่เฉพาะเจาะจงของผู้ใช้