หน้านี้มีรายละเอียดโครงการงานเขียนเชิงเทคนิคที่ได้รับการยอมรับใน Google Season of เอกสาร
สรุปโปรเจ็กต์
- องค์กรโอเพนซอร์ส
- moja global
- นักเขียนเชิงเทคนิค:
- แอนโธนี
- ชื่อโปรเจ็กต์:
- เอกสารประกอบเกี่ยวกับรหัสเครื่องมือการรายงาน
- ระยะเวลาของโปรเจ็กต์
- ระยะเวลามาตรฐาน (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) รูปแบบ บทความอ้างอิงที่อธิบายถึงสิ่งต่อไปนี้ ก) องค์ประกอบการออกแบบหลักที่ประกอบกันเป็นเครื่องมือ ข) การแยกองค์ประกอบข้างต้นตามฟังก์ชันการทำงาน ค) องค์ประกอบการดําเนินการขององค์ประกอบที่แยกตามฟังก์ชันการทำงาน ง) การจัดระเบียบซอร์สโค้ด / ไลบรารีของเครื่องมือ จ) วิสัยทัศน์และทิศทางระยะยาวสําหรับการปรับปรุงอย่างต่อเนื่อง ฉ) ขอบเขตถัดไปที่ควรปรับปรุง
และบทแนะนำสั้นๆ ที่อธิบายวิธีปรับโค้ดให้เข้ากับสถานการณ์เฉพาะของผู้ใช้