การอ้างอิงที่ดีสำหรับตัวอย่างเอกสารผู้ใช้ปลายทางและแนะนำ [ปิด]

ซอฟต์แวร์ภายใน บริษัท ของเราถูกใช้สำหรับผู้ใช้จำนวนมากและฝ่ายฝึกอบรมขอให้เราทราบเคล็ดลับเกี่ยวกับรูปแบบเอกสารผู้ใช้ปลายทาง

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

นี่คล้ายกับคำถามนี้แต่ฉันกำลังมองหาเอกสารสำหรับผู้ใช้เพื่อใช้งานโดยผู้ใช้ที่ไม่ใช่ด้านเทคนิค

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

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

บางหัวข้ออาจครอบคลุม:

1. กลุ่มเป้าหมาย
2. ความต้องการทางด้านเทคนิค
3. วิธีการติดตั้ง (ถ้ามี)
4. กระบวนการ (เช่นซอฟต์แวร์ธุรกิจทำหน้าที่อะไร?)
5. Featureet (ซอฟต์แวร์มีฟีเจอร์อะไรบ้าง)
   • คุณสามารถมีวิธีการทำงานแบบนี้เช่นเพิ่มผู้ใช้หรือเพิ่มเอกสาร
   • คุณสามารถมีวิธีการใช้วัตถุเช่นผู้ใช้บทบาท
   • คุณสามารถมีวิธีการใช้เมนูเช่นเมนูไฟล์ดูเมนู
6. สุดท้ายอาจเป็นคุณลักษณะที่กำลังจะมีขึ้นและส่วนคำถามที่พบบ่อยอาจทำหน้าที่เป็นแหล่งเก็บความรู้ที่เพิ่มขึ้นของผลิตภัณฑ์ของคุณ

พยายามคาดการณ์ว่าผู้ใช้ของคุณใช้ซอฟต์แวร์อย่างไรโดยอิงจากความรู้ในการพัฒนาซอฟต์แวร์ของคุณความรู้ในสิ่งที่มันทำและจากการสัมภาษณ์ของคุณกับผู้ใช้ปลายทาง (หวังว่า)

ที่สำคัญที่สุดลองทำเอกสารที่คุณต้องการอ่านใช้ชื่อตัวอย่างสนุก ๆ เพื่อสาธิตและใช้ภาพหน้าจอที่มีคำอธิบายประกอบจำนวนมาก

หวังว่านี่จะช่วยได้

ฉันได้อ่าน "ผู้ใช้ปลายทาง" หลายคนและเขียนหนึ่งและฉันคิดว่ามีองค์ประกอบหลายอย่างที่ปรับปรุงประสิทธิภาพของพวกเขา:

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

ฉันหวังว่านี่อาจเป็นประโยชน์สำหรับคุณ

คุณพูดถึงว่ามันจะใช้สำหรับการฝึกอบรม

หากคุณกำลังมองหาเอกสารการฝึกอบรมมากกว่าเอกสารอ้างอิงเว็บไซต์ดังกล่าวที่ชื่นชอบคือการสอนโจ Spolsky ใน Mercurial ที่นี่

1. การนำเสนอที่เรียบง่ายและสะอาดตา มันดูดีมาก
2. มีอำนาจ แต่เป็นน้ำเสียงส่วนตัว รู้สึกเหมือนคุณกำลังเข้าเรียนในวิทยาลัยที่ยอดเยี่ยม
3. ภาพที่เรียบง่ายไม่ใช่ภาพหน้าจอจริงจำนวนมาก อ่านThe Back of the Napkinว่าทำไมสิ่งนี้ถึงได้ผล

หากคุณกำลังฝึกอบรมเอกสารอยู่ที่ 1/2 ซึ่งยอดเยี่ยมเท่ากับการสอน Mercurial ของ Joel ฉันจะอ่านมัน แต่คุณต้องการใครสักคนที่มี a) ความหลงใหลในการเขียนและ b) ความรู้ที่ลึกซึ้งอย่างไม่น่าเชื่อเพื่อดึงมันออกมาแม้ว่าคุณจะสามารถคัดลอก 3 คะแนนด้านบน หวังว่ามันจะได้ผล

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

ฉันเพิ่งวิ่งข้ามReadTheDocsซึ่งทำสิ่งเดียวกัน แต่เป็นวิธีแก้ปัญหาที่โฮสต์

ตรวจสอบสมาคมเทคนิคการสื่อสาร (STC) ผู้ชนะรางวัลมากมายของพวกเขาเขียนการผลิตที่มีอยู่ทั่วไป พวกเขาอาจมีตัวอย่าง การเป็นสมาชิกจะทำให้สามารถเข้าถึงข้อมูลที่ใหญ่ขึ้นได้