เอกสารประกอบผลิตภัณฑ์
ช่วยให้ผู้ใช้ทำภารกิจต่างๆ ที่แอปพลิเคชันของคุณรองรับให้เสร็จสิ้น
จัดทำคู่มือที่เป็นประโยชน์ ซึ่งอธิบายขั้นตอนการใช้งานแอปพลิเคชัน และช่วยให้ผู้ใช้สามารถทำภารกิจต่างๆ ให้สำเร็จได้
เปลี่ยนคุณสมบัติของผลิตภัณฑ์ให้เป็นคำแนะนำที่ใช้งานได้จริง
- เตรียมขอบเขตของไกด์
ตรวจสอบส่วนต่างๆ ของเอกสารและกลุ่มเป้าหมายที่ตั้งใจไว้
- ตอบคำถามเนื้อหา
อธิบายขั้นตอนการทำงานและข้อมูลที่คู่มือควรให้คำแนะนำ
- ทำตามคำแนะนำของบริการสาธารณะ
ตรวจสอบความคืบหน้าของการสร้างและที่อยู่ของเว็บไซต์เอกสารประกอบ
อธิบายวิธีการใช้งานแอปพลิเคชัน
เอกสารประกอบจะช่วยเสริมการนำเสนอผลิตภัณฑ์ด้วยคำแนะนำที่เป็นประโยชน์ เริ่มต้นด้วยคำแนะนำในการเริ่มต้นใช้งาน จากนั้นนำผู้ใช้ไปสู่ขั้นตอนการทำงานที่แอปพลิเคชันรองรับ
การกำหนดค่าเอกสารประกอบจะแสดงส่วนคำจำกัดความและคำถาม ให้ข้อมูลเพิ่มเติมที่ช่วยอธิบายงานในภาษาของผู้ใช้
เชื่อมต่อคำแนะนำไว้กับแอปพลิเคชันที่ใช้งานอยู่
ดำเนินการตามขั้นตอนที่เป็นประโยชน์ครั้งแรก. คู่มือเริ่มต้นจะช่วยให้ผู้ใช้ใหม่สามารถเริ่มต้นใช้งานผลิตภัณฑ์ได้อย่างรวดเร็ว คู่มือนี้ควรอธิบายว่าควรเริ่มต้นจากตรงไหน ข้อมูลใดที่จำเป็น และผลลัพธ์ใดที่แสดงว่างานเสร็จสมบูรณ์แล้ว
อธิบายขั้นตอนการทำงานที่ทำซ้ำ. คู่มือฉบับละเอียดจะอธิบายขั้นตอนการใช้งานจริง รวมถึงป้ายกำกับและขั้นตอนต่างๆ ข้อกำหนดเบื้องต้น ขั้นตอนที่เป็นลำดับ และผลลัพธ์ที่คาดหวัง จะช่วยให้ผู้ใช้สามารถทำซ้ำขั้นตอนการทำงานได้อย่างถูกต้อง โดยไม่ต้องตีความจากคำอธิบายทั่วไปของหน้าจอ
ตอบคำถามที่เกี่ยวข้องกับหลายส่วน. คำถามบางข้อเกี่ยวข้องกับบัญชี ค่าใช้จ่าย หรือการเผยแพร่งาน มากกว่าที่จะเป็นแค่หนึ่งหน้าจอ คำถามที่พบบ่อย (FAQ) จะให้คำตอบที่กระชับและลิงก์ไปยังคู่มือที่เกี่ยวข้อง โดยเก็บขั้นตอนไว้ในที่เดียว แทนที่จะทำซ้ำไปทั่วทั้งเว็บไซต์
เชื่อมต่อคำแนะนำกับผลิตภัณฑ์ไว้
ตรวจสอบเอกสารหลังจากมีการเปลี่ยนแปลงแอปพลิเคชันที่มีความสำคัญ คู่มือควรใช้ป้ายกำกับและพฤติกรรมที่ผู้ใช้สามารถเห็นได้จริง
เอกสารประกอบนี้จะทำงานบนบริการสาธารณะของตัวเอง เชื่อมโยงจากเว็บไซต์ และตรวจสอบคู่มือในภาษาที่คุณเผยแพร่สำหรับโปรเจ็กต์ของคุณ
ช่วยเหลือผู้ใช้ให้ทำภารกิจถัดไปให้สำเร็จ
คู่มือฉบับปฏิบัติอธิบายว่าควรเริ่มต้นจากตรงไหน ข้อมูลใดที่จำเป็น และวิธีการตรวจสอบผลลัพธ์ ค่าของมันอยู่ที่การช่วยให้ผู้อ่านสามารถนำไปปฏิบัติได้จริง
ใช้คู่มือที่เกี่ยวข้องเพื่อดำเนินการต่อเมื่องานครอบคลุมหลายส่วน ตรวจสอบเอกสารประกอบเมื่อหน้าจอเปลี่ยนแปลง เพื่อให้คำแนะนำยังคงมีประโยชน์แม้หลังจากการปรับปรุง
จากฟังก์ชันการทำงานที่ตกลงกันไว้ สู่ความช่วยเหลือที่มีประโยชน์
เตรียมอุปกรณ์ส่องดู. ตรวจสอบส่วนต่างๆ ของเอกสารและงานที่ควรจะอธิบาย ตรวจสอบให้แน่ใจว่าผู้ใช้และพฤติกรรมของแอปพลิเคชันเป็นไปตามที่ตั้งใจไว้
กรุณาใส่ข้อมูลเพิ่มเติม. ตอบคำถามเกี่ยวกับข้อกำหนดเกณฑ์ และผลลัพธ์ การเขียนควรใช้ส่วนต่อประสานจริง แทนที่จะใช้ส่วนควบคุมที่คิดขึ้น
รีวิวหลังการเผยแพร่และแก้ไข. ทำตามคำแนะนำในแอปพลิเคชัน ตรวจสอบภาษาและลิงก์ที่เกี่ยวข้อง จากนั้นกลับมาดูอีกครั้งเมื่องานพื้นฐานเปลี่ยนแปลง
ทำให้ผลิตภัณฑ์ใช้งานได้ง่ายขึ้นหลังจากใช้งานครั้งแรก
ให้คำแนะนำที่เป็นขั้นตอนเพื่อให้ได้ผลลัพธ์ พร้อมทั้งอธิบายการทำงานของแอปพลิเคชันให้ผู้ใช้ทราบ
คำถามเกี่ยวกับเอกสารประกอบผลิตภัณฑ์
หน้าคุณสมบัติช่วยให้ผู้มีโอกาสเป็นลูกค้าเข้าใจถึงความสามารถและคุณค่าของผลิตภัณฑ์ คู่มือช่วยให้ผู้ใช้ทำงานให้สำเร็จ โดยมีส่วนควบคุม ข้อกำหนดเบื้องต้น และผลลัพธ์ที่แท้จริง ทั้งสองสิ่งนี้ช่วยเสริมซึ่งกันและกัน
เครื่องมือสร้างเอกสารจะแสดงส่วนต่างๆ และคำถาม ตรวจสอบงานที่แอปพลิเคชันรองรับ เพิ่มบริบทที่ขาดหายไป และติดตามความคืบหน้าในการเขียน
โครงการนี้เผยแพร่คู่มือที่แปลเป็นภาษาต่างๆ ที่มีอยู่ในขอบเขตของโครงการ ตรวจสอบแต่ละภาษาที่เผยแพร่เพื่อให้แน่ใจว่ายังคงมีขั้นตอนที่สมบูรณ์และป้ายกำกับส่วนติดต่อผู้ใช้ที่ถูกต้อง
หลังจากมีการเปลี่ยนแปลงซึ่งส่งผลต่องาน การควบคุม หรือผลลัพธ์ที่คาดหวัง ให้ตรวจสอบข้อความเทียบกับแอปพลิเคชันที่ใช้งานจริง แทนที่จะคิดว่าคำแนะนำเดิมยังคงถูกต้อง
การอ้างอิงเอนด์พอยต์นั้นเป็นส่วนหนึ่งของโปรเจ็กต์ที่มี API ที่ทำงานอยู่และใช้งานได้ ใช้การทำงานจริงและการอ้างอิงจริง การวางแผนเส้นทางอย่างเดียวไม่เพียงพอต่อการจัดทำเอกสารสำหรับการผสานรวมที่ใช้งานได้