คู่มือการใช้งาน - วิธีการถึงวันที่?

หากคุณมีผลิตภัณฑ์ที่อยู่ในตลาดมาเป็นเวลานาน แต่มันยังอยู่ในการพัฒนาที่ใช้งานอยู่ทุกวัน - ควรอัพเดทคู่มือบ่อยแค่ไหน? หากผู้ใช้ของคุณได้รับการอัปเดตเป็นรุ่นที่ทันสมัยอยู่เสมอเนื่องจากองค์กรของคุณเห็นว่าการแก้ไขข้อบกพร่องล่าสุดนั้นอยู่ในเวอร์ชันที่จัดส่งอยู่เสมอ หมายความว่าคุณสามารถแก้ไขข้อบกพร่องได้ในวันหนึ่งและวันถัดไปที่กำลังเกิดการผลิต

ฉันจะอัปเดตคู่มือ:

1. สำหรับแต่ละรุ่นใหญ่และ
2. เมื่อคุณสมบัติใหม่ที่สำคัญมีความเสถียรและเป็นผู้ใหญ่พอที่คุณจะรู้ว่าพวกเขาจะไม่เปลี่ยนแปลงทุก ๆ ห้านาที

อัปเดตคู่มือ (PDF) เมื่อใดก็ตามที่การเปลี่ยนรหัสจะเปลี่ยนคำแนะนำในคู่มือ - เพียงแค่ทำการอัปเดตส่วนที่ทำด้วยตนเองของกระบวนการเผยแพร่

หากผู้ใช้พึ่งพาคู่มือเพื่อบอกวิธีการใช้ผลิตภัณฑ์และการเปลี่ยนแปลงผลิตภัณฑ์ก็เป็นเพียงสามัญสำนึกที่ส่วนที่เกี่ยวข้องของคู่มือควรเปลี่ยนด้วย

ในปี 2010 เรายังคงอ้างถึงเอกสารที่พิมพ์ออกมาหรือไม่? ทำไม? ;)

ในเรื่องจริงจังเอกสาร (อย่างใดอย่างหนึ่งความช่วยเหลือเกี่ยวกับแอปพลิเคชัน "F1" PDF หรือเอกสารออนไลน์) ควรเป็นส่วนหนึ่งของการเปิดตัวทุกครั้ง แก้ตัวเป็นศูนย์ ง่ายมากที่จะ "เผยแพร่" ตามความเป็นจริง IMO ไม่มีข้อแก้ตัวใด ๆ ที่จะไม่อัปเดตเอกสารเป็นประจำ (ออนไลน์และ PDF) แม้จะอยู่ในระหว่างการเผยแพร่ทันทีที่มีการรู้และแก้ไขปัญหา ไม่ต้องการระดับ QA เดียวกัน - ไม่ต้องปิด

ฉันถือว่าคุณกำลังพูดถึงเอกสารผู้ใช้ปลายทาง การเขียนเอกสารเป็นความเจ็บปวดใน @ $$ และในขณะที่ฉันได้พัฒนาเทคนิคบางอย่างเพื่อโน้มน้าวฉันในทางกลับกันฉันยังคงมีปัญหากับสิ่งนั้น นี่คือวิธีที่ฉันพยายามจัดการ:

รวมการปรับปรุงเอกสารใน DoD ของคุณ ( คำจำกัดความของการทำ )

เพื่อให้มั่นใจว่าเอกสารของคุณจะเป็นข้อมูลล่าสุดในตอนท้ายของการทำให้เรื่องราวของผู้ใช้เสร็จสมบูรณ์

นี่คือคำจำกัดความของการกระทำที่เราเขียน ฉันพยายามเก็บรูปแบบดั้งเดิมไว้ดังนั้นคุณจะได้ความคิด มันเป็นหน้า A4 วางบนไวท์บอร์ด

---------- 8 <------------ ตัดตรงนี้ ------------ 8 <----------

การต่อรองไม่ได้

คำจำกัดความของ "เสร็จสิ้น"

• รหัสที่มีขอบเขตการทดสอบ 80% ครอบคลุมในพื้นที่เก็บข้อมูล

• ภาพหน้าจอถ้ามี (1024x728, 395x281, 170x121 & 729x329)

• คำอธิบายคุณลักษณะหากมี (50 ตัวอักษร, 100 ตัวอักษร)

• เอกสารสำหรับผู้ใช้แบบสมบูรณ์

• มีการอัพเดทไฟล์ใหม่อะไรบ้าง

---------- 8 <------------ ตัดตรงนี้ ------------ 8 <----------

แน่นอนคุณสามารถเพิ่มกระบวนการตรวจสอบในเอกสารประกอบ เรามีสิ่งนั้นเนื่องจากเราไม่มีใครเป็นเจ้าของภาษาอังกฤษ

หนึ่งในข้อได้เปรียบของความหมายของการเสร็จสิ้นเช่นนี้ก็คือว่าผลิตภัณฑ์ของคุณอาจเป็น shippable ในตอนท้ายของแต่ละเสร็จสิ้นเรื่องราวของผู้ใช้

ใช้เทคนิคนี้ในการรวมกันกับคนนี้

ในองค์กรของฉันโดยทั่วไปเรามีการเผยแพร่ 3 ชนิด:

1. Engineering Release - การแก้ไขร้อนโดยทั่วไปสำหรับลูกค้าบางรายหรือคุณลักษณะบางอย่างเฉพาะลูกค้าเฉพาะรายที่ได้ร้องขอในทันที
2. Minor Release - การแก้ไขข้อผิดพลาด, การสนับสนุนที่เพิ่มขึ้น
3. Major Release - รองรับคุณสมบัติใหม่ ๆ

ตามคำนิยามเมเจอร์รีลีสจะต้องมีเอกสารที่เกี่ยวข้องทั้งออนไลน์และออฟไลน์ ระบบติดตามของเรารับรองว่าเอกสารเป็นส่วนหนึ่งของรายการตรวจสอบ

การเปิดตัวของผู้เยาว์นั้นต้องการเอกสารเกี่ยวกับสิ่งใหม่ที่เพิ่มเข้ามาในระดับการรับรู้ของผู้ใช้ ดังนั้นหากคุณรวมฮิวริสติกอื่นเข้าด้วยกันซึ่งอาจลดความซับซ้อนของเวลาในบางสถานการณ์มันอาจจะใช่หรือไม่ใช่การเรียกที่สำคัญที่จะนำมาใส่ใน pdf

การเผยแพร่ทางวิศวกรรมสามารถทำได้โดยไม่มีเอกสารประกอบ บันทึกการใช้งานนอกระบบบางอย่างควรดีพอที่จะเริ่มต้นใช้งาน

เอกสารควรทำข้อมูลให้ตรงกับซอฟต์แวร์ที่คุณจัดส่งให้กับลูกค้า การแข่งขันที่ผิดพลาดอื่น ๆ จะทำให้คุณมีปัญหา และถ้าคุณไม่มีนักเขียนให้ลองผู้รับเหมา เมื่อคุณพบคนที่คุณชอบให้เขาไว้