คู่มือนี้มีจุดประสงค์เพื่อช่วยให้องค์กรเข้าใจว่าปัญหาประเภทใดที่อาจแก้ไขได้ด้วยเอกสารประกอบที่ดีขึ้น และวิธีเลือกเมตริกที่เหมาะสมสำหรับโครงการเอกสาร
ระยะปัจจุบัน:
การพัฒนาเอกสาร ดูไทม์ไลน์
ระบุปัญหาของคุณ
ก่อนที่จะเริ่มต้นเลือกเมตริก คุณควรทำความเข้าใจปัญหาที่คุณพยายามจะแก้ให้ดี โปรดระบุให้เฉพาะเจาะจงที่สุด
- "คำขอการดึงสำหรับเอกสารประกอบการเริ่มต้นใช้งานของเราใช้เวลานานเกินไปในการผสานรวม ผู้ร่วมให้ข้อมูลยอมแพ้และออกไป"
- "เราพบปัญหามากเกินไปในการช่วยเข้าใจรหัสข้อผิดพลาด"
- "ไปป์ไลน์ CI/CD ของเราไม่สม่ำเสมอ การทดสอบล้มเหลวหลายครั้งเกินไปด้วยเหตุผลที่ไม่เข้าใจ"
- "การประชุมรายสัปดาห์ของเรามีคนหน้าบึ้งตึง"
สร้างสมมติฐาน
มองหาสาเหตุและผลกระทบ อะไรคือสาเหตุของปัญหาที่คุณระบุไว้ โปรดทราบว่าปัญหาอาจมีหลายสาเหตุหรือหลายสาเหตุ
- "การรวมคำขอพุลนั้นใช้เวลานานมากสำหรับเอกสารการเริ่มต้นใช้งานเนื่องจากเราไม่มีคำแนะนำที่ชัดเจนเกี่ยวกับสไตล์ ผู้ตรวจสอบอาจเลื่อนการตรวจสอบการประชาสัมพันธ์เนื่องจากไม่ทราบว่าต้องทำอะไร หรือกลับไปกลับมาหาผู้ให้ข้อมูลร่วมกันเกี่ยวกับการจัดรูปแบบ"
- "ผู้ใช้ต้องเปิดปัญหาเนื่องจากไม่พบข้อมูลเกี่ยวกับรหัสข้อผิดพลาดในเอกสาร"
- "การทดสอบ CI/CD ล้มเหลวเนื่องจากพบข้อจำกัดของแผนและระยะหมดเวลาจากผู้ให้บริการ"
- "ผู้คนหน้าบึ้งในการประชุมรายสัปดาห์ของเรา เพราะการประชุมจัดขึ้นเวลา 5.30 น. ตามเขตเวลาของพวกเขา"
เสนอโซลูชัน
ปัญหานี้ที่แก้ไขได้ด้วยเอกสารประกอบใหม่หรือดีกว่าหรือไม่
- "หากเรามีคู่มือให้คำแนะนำ คณะกรรมการจะดูได้ก่อนที่จะส่ง PR ผู้ตรวจสอบทราบว่าควรตรวจสอบสิ่งใด นักรีวิวและผู้มีส่วนร่วมจะได้ไม่ต้องถกเถียงเรื่องการจัดรูปแบบ โทน และสไตล์"
- "หากเรามีเอกสารเกี่ยวกับรหัสข้อผิดพลาด ผู้ใช้จะค้นหาคำตอบได้ที่นั่น โดยไม่ต้องเปิดประเด็นปัญหา"
- "อืม ดูเหมือนว่าเอกสารประกอบที่จะแก้ปัญหา CI/CD ของเราไม่ได้ดีไปกว่านี้"
- "เราเริ่มการประชุมแต่ละครั้งได้ด้วยมุกตลกน็อกเอาต์ การสร้างคอลเล็กชันมุกตลกเคาะประตูจะช่วยให้เราเริ่มต้นการประชุมได้ด้วยรอยยิ้ม"
ระบุรายละเอียดที่เฉพาะเจาะจง
คุณช่วยวัดปริมาณปัญหาได้ไหม
- "การ 'การรวม PR เข้าด้วยกันใช้เวลานานเกินไป' หมายความว่าอะไร แล้วถ้า 2 เดือน 2 สัปดาห์ ผู้ร่วมให้ข้อมูลจะต้องรอตรวจสอบนานเท่าใดก่อนที่จะออกจากหน้านี้"
- "ปัญหาที่เกี่ยวข้องกับรหัสข้อผิดพลาดมี "ปัญหามากเกินไป" กี่รายการ"
- "อืมม ...
ตรวจสอบความสามารถในการวัด
คุณจะตรวจสอบเมตริกที่เสนออย่างไร วัดผลได้ง่ายและแม่นยำไหม การวัดขึ้นอยู่กับผู้ที่วัดผลหรือไม่
- "เราสามารถวัดได้โดยง่ายว่าคำขอดึงข้อมูลเปิดไว้นานเท่าใดและนับตั้งแต่มีการขอรับการตรวจสอบ เราไม่สามารถวัดได้แน่ชัดว่า ผู้ร่วมให้ข้อมูลจะเลิกให้ความสนใจเมื่อใด"
- "เราสามารถนับจำนวนปัญหาที่มีการติดแท็ก "รหัสข้อผิดพลาด" หรือการค้นหาภายในปัญหาสำหรับข้อความรหัสข้อผิดพลาด"
- "เราวัดความไม่สบายใจของผู้คนด้วยวิธีที่แม่นยำหรือแม่นยำไม่ได้"
เพิ่มเมตริกรอง
มีเมตริกอื่นๆ ที่จะช่วยให้คุณเข้าใจว่าเอกสารช่วยแก้ปัญหาไหม เมตริกเป้าหมายของคุณเหมือนกันทุกกรณีไหม
- "ฝ่าย PR ที่ยาวกว่าจะใช้เวลาตรวจสอบนานกว่า เราควรมีเกณฑ์ที่แตกต่างกันสำหรับ PR ขนาดต่างๆ เราต้องการวัดเวลาในการผสานรวมสำหรับ PR ขนาดเล็ก กลาง ใหญ่ และขนาดใหญ่"
- "เราสามารถตรวจสอบจำนวนการเข้าชมที่เอกสารเกี่ยวกับรหัสข้อผิดพลาดของเราได้รับ และดูว่าจำนวนนั้นเกี่ยวข้องกับปัญหาที่น้อยลงหรือไม่"
เลือกระยะเวลา
- "เราคิดว่า 2 สัปดาห์เป็นเวลาที่เหมาะสมในการรวม PR ขนาดเล็กถึงขนาดกลาง เข้าด้วยกัน โดยการรวม PR ทั้งหมดควรรวมกันภายใน 1 เดือน เราจะวัดผลทุกๆ 2 สัปดาห์"
- "เราไม่ควรอัปเดตจำนวนปัญหาที่เกี่ยวข้องกับรหัสข้อผิดพลาดทุกวัน เพราะเวลาโดยทั่วไปของเราในการปิดปัญหาคือ 1 สัปดาห์ เราจะวัดผลทุกสัปดาห์"
ตั้งเป้าหมาย
คุณต้องเห็นการเปลี่ยนแปลงมากน้อยเพียงใดในเมตริกที่เลือกเพื่อบอกว่าโครงการประสบความสำเร็จ ลองตั้งเป้าหมายเชิงปริมาณสำหรับเมตริกที่เลือก
- "ถ้าเราบรรลุเป้าหมายในการปิดการประชาสัมพันธ์ใหม่ทุกครั้งในเวลาไม่ถึง 1 เดือน ก็ถือว่าประสบความสำเร็จ ถ้าเวลาเฉลี่ยในการปิด PR ขนาดใหญ่ลดลง 2 สัปดาห์ ก็จะประสบความสำเร็จอย่างล้นหลาม"
- "ตามหลักแล้ว เราจะไม่พบปัญหาใหม่ที่เกี่ยวข้องกับข้อผิดพลาด แต่เราจะถือว่าโครงการของเราประสบความสำเร็จหากเห็นว่าปัญหาที่เกี่ยวข้องกับข้อผิดพลาดลดลงถึง 50%"
ข้อมูลที่เกี่ยวข้อง
- อ่านคู่มือผู้ดูแลระบบองค์กรเพื่อรับความช่วยเหลือเกี่ยวกับงานที่เกี่ยวข้องกับรายงาน