เอกสารซอฟต์แวร์คืออะไร? ประเภทและแนวทางปฏิบัติที่ดีที่สุดในการเริ่มต้น

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

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

ในโพสต์นี้ เราจะเจาะลึกทุกสิ่งที่คุณจำเป็นต้องรู้เกี่ยวกับเอกสารประกอบซอฟต์แวร์ รวมถึงสิ่งต่อไปนี้:

• เอกสารประกอบซอฟต์แวร์คืออะไร?
• เอกสารคู่มือซอฟต์แวร์ประเภทต่างๆ (พร้อมตัวอย่าง)
• วิธีเผยแพร่เอกสารซอฟต์แวร์ของคุณ (เครื่องมือที่ดีที่สุด)
• แนวทางปฏิบัติที่ดีที่สุดสำหรับการสร้างเอกสารซอฟต์แวร์ที่มีคุณภาพ

มาขุดกันเถอะ!

เอกสารซอฟต์แวร์คืออะไร?

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

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

ภายในคำจำกัดความกว้างๆ ของเอกสารประกอบซอฟต์แวร์ มีเอกสารประกอบซอฟต์แวร์หลายประเภท เรามาคุยกันต่อไป

เอกสารประกอบซอฟต์แวร์ประเภทต่างๆ

คุณสามารถแบ่งเอกสารประกอบซอฟต์แวร์ประเภทต่างๆ ได้เป็นหมวดหมู่กว้างๆ

ข้อพิจารณาประการแรกคือประเภทของบุคคลที่มีไว้สำหรับเอกสาร:

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

ข้อพิจารณาประการที่สองคือเอกสารมีไว้สำหรับผู้ชมภายนอกหรือภายใน:

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

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

เรามาแจกแจงรายละเอียดเกี่ยวกับเอกสารประกอบซอฟต์แวร์ประเภทนี้กันสักหน่อย...

ตัวอย่างเอกสารซอฟต์แวร์สำหรับเอกสารนักพัฒนา

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

สำหรับตัวอย่างเอกสารซอฟต์แวร์จริงของเอกสารที่เน้นนักพัฒนา คุณสามารถดูเอกสารประกอบ “นักพัฒนา” ของ Gravity Forms ที่ครอบคลุมหัวข้อต่างๆ เช่น:

• ตะขอ PHP (สำหรับ WordPress)
• วัตถุข้อมูล
• PHP API
• ฐานข้อมูล
• ส่วนที่เหลือ API

ตัวอย่างเช่น เอกสาร REST API มีลักษณะดังนี้:

ตัวอย่างเอกสารซอฟต์แวร์สำหรับเอกสารผู้ใช้

• คู่มือเริ่มต้นใช้งาน – แสดงให้ผู้ใช้เห็นวิธีเริ่มต้นและใช้งานซอฟต์แวร์ของคุณอย่างรวดเร็ว
• แบบฝึกหัดสำหรับกรณีการใช้งานเฉพาะ - แบบฝึกหัดเฉพาะเพิ่มเติมสำหรับการทำงานเฉพาะให้สำเร็จ
• อภิธานศัพท์คำศัพท์/คู่มืออ้างอิง – ช่วยให้ผู้ใช้เข้าใจคำศัพท์และรายละเอียดที่สำคัญ
• FAQs – ตอบคำถามที่พบบ่อย

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

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

เมื่อเทียบกับเอกสารประกอบซอฟต์แวร์สำหรับนักพัฒนา คุณจะเห็นภาพหน้าจอและคำอธิบายภาษาธรรมดามากกว่า และบล็อกโค้ดน้อยกว่ามาก

วิธีเผยแพร่เอกสารซอฟต์แวร์: เครื่องมือเอกสารซอฟต์แวร์ที่ดีที่สุดสามรายการ

หากต้องการเผยแพร่เอกสารประกอบซอฟต์แวร์ของคุณบนเว็บไซต์ คุณต้องมีเครื่องมือเอกสารซอฟต์แวร์เฉพาะหรือระบบการจัดการความรู้บางประเภท

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

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

ฐานความรู้ฮีโร่

Heroic Knowledge Base เป็นเอกสารประกอบและปลั๊กอินฐานความรู้สำหรับซอฟต์แวร์ WordPress แบบโอเพ่นซอร์สยอดนิยม

ด้วย Heroic Knowledge Base คุณสามารถโฮสต์เอกสารของคุณเองและควบคุมได้อย่างเต็มที่ ในขณะที่ยังคงเข้าถึงคุณลักษณะทั้งหมดที่คุณต้องการเพื่อสร้างเอกสารซอฟต์แวร์ที่มีประสิทธิภาพ

ต่อไปนี้เป็นคุณสมบัติหลักบางประการที่คุณได้รับจาก Heroic Knowledge Base:

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

เนื่องจาก Heroic Knowledge Base และ WordPress เป็นทั้งโฮสต์เองและเป็นโอเพ่นซอร์ส คุณจึงแก้ไขการตั้งค่าได้ตามต้องการ

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

Heroic Knowledge Base เริ่มต้นเพียง $149 ต่อปี

อ่านเอกสาร

Read the Docs เป็นเครื่องมือจัดทำเอกสารที่เน้นการช่วยคุณสร้างเอกสารประกอบสำหรับนักพัฒนาซอฟต์แวร์

หากคุณมุ่งเน้นที่การสร้างเอกสารทางเทคนิคสำหรับนักพัฒนาโดยเฉพาะ ก็อาจเป็นตัวเลือกที่ดีอีกตัวเลือกหนึ่งที่ควรพิจารณา

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

ต่อไปนี้เป็นคุณสมบัติที่โดดเด่นอื่นๆ ใน Read the Docs:

• การวิเคราะห์ในตัว เพื่อดูว่าผู้ใช้ของคุณกำลังอ่านและค้นหาอะไร
• รองรับการสร้างพร้อมกันหลาย รุ่น ซึ่งจะเป็นประโยชน์หากคุณมีซอฟต์แวร์หลายเวอร์ชัน เช่น เอกสารประกอบหนึ่งชุดสำหรับเวอร์ชัน 1.0 และอีกชุดหนึ่งสำหรับเวอร์ชัน 2.0
• ส่งออกเอกสาร ในรูปแบบต่างๆ รวมถึง PDF, HTML และ epub
• คำแนะนำ การค้นหาสด เพื่อช่วยผู้ใช้ในการค้นหาเอกสาร

อ่านเอกสารได้ฟรีหากคุณมีโครงการซอฟต์แวร์โอเพ่นซอร์ส

สำหรับผลิตภัณฑ์ซอฟต์แวร์เชิงพาณิชย์ มีบริการอ่านเอกสารสำหรับธุรกิจแบบชำระเงินซึ่งเริ่มต้นที่ 50 ดอลลาร์ต่อเดือน

GitBook

GitBook เป็นเครื่องมือเอกสารทางเทคนิคซอฟต์แวร์อีกตัวที่ช่วยให้คุณจัดการเอกสารของคุณโดยใช้ Git โดยรองรับทั้งที่เก็บ GitHub และ GitLab

หรือหากคุณไม่ต้องการใช้ Git GitBook ยังให้คุณสร้างเอกสารประกอบโดยใช้โปรแกรมแก้ไขข้อความหรือนำเข้าจากไฟล์มาร์กดาวน์หรือไฟล์ .doc

นี่คือคุณสมบัติเด่นอื่น ๆ ที่ GitBook นำเสนอ:

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

GitBook เป็นบริการฟรีสำหรับโครงการที่ไม่หวังผลกำไรหรือโอเพ่นซอร์ส

สำหรับโครงการซอฟต์แวร์เชิงพาณิชย์ GitBook เริ่มต้นที่ $8 ต่อผู้ใช้ต่อเดือน โดยมีผู้ใช้ขั้นต่ำ 5 คน นั่นหมายถึงอัตรารายเดือนที่ถูกที่สุดคือ $40 ต่อเดือน

แนวทางปฏิบัติที่ดีที่สุดสำหรับการสร้างเอกสารประกอบซอฟต์แวร์

เรามาเจาะลึกแนวทางปฏิบัติที่ดีที่สุดเกี่ยวกับเอกสารซอฟต์แวร์เพื่อช่วยคุณสร้างเอกสารที่มีประสิทธิภาพ

คิดถึงเป้าหมายและความต้องการของผู้ใช้

เมื่อคุณเขียนบทความเอกสารประกอบซอฟต์แวร์ สิ่งสำคัญคือต้องเริ่มต้นด้วยการตอบคำถามพื้นฐานสองสามข้อ:

• ผู้ใช้ที่คุณเขียนถึงคือใคร
• ผู้ใช้พยายามทำอะไรให้สำเร็จ
• ผู้ใช้มีความรู้ทางเทคนิคระดับใด

การรู้คำตอบสำหรับคำถามเหล่านี้จะช่วยให้คุณเข้าใจว่าเนื้อหาใดครอบคลุมและวิธีจัดโครงสร้างบทความด้วยวิธีที่เหมาะสมที่สุด

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

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

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

รวมเอกสารซอฟต์แวร์ในกระบวนการพัฒนา

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

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

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

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

ใช้การจัดรูปแบบและสไตล์ที่สอดคล้องกัน

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

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

เพื่อช่วยให้บรรลุความสอดคล้องกัน คุณอาจต้องการสร้างคู่มือสไตล์เอกสารประกอบซอฟต์แวร์โดยเฉพาะ

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

ตัวอย่างเช่น ปลั๊กอิน Heroic Knowledge Base มีคำบรรยายลักษณะล่วงหน้าเพื่อเน้นข้อมูลสำคัญหรือคำเตือน เมื่อใช้สิ่งเหล่านี้ คุณจะมั่นใจได้ว่าการจัดรูปแบบจะสอดคล้องกันในเอกสารทั้งหมดของคุณ

ใช้ผู้เชี่ยวชาญในการเขียนเอกสารทางเทคนิค

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

อย่างไรก็ตาม สำหรับเอกสารทางเทคนิคซอฟต์แวร์เพิ่มเติม เช่น เอกสาร API ที่เน้นนักพัฒนา คุณอาจต้องการมอบหมายให้บุคคลที่มีความรู้ทางเทคนิคที่เกี่ยวข้องเขียนเอกสารเหล่านั้น

นี่อาจเป็นนักเขียนด้านเทคนิคโดยเฉพาะที่มีความเชี่ยวชาญด้านโดเมน หากองค์กรของคุณมีทรัพยากรที่จะจ้างสำหรับตำแหน่งนั้น หรืออาจเป็นหนึ่งในนักพัฒนาของคุณ

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

ทำให้ผู้คนค้นพบเนื้อหาได้ง่าย (ค้นหา/กรอง)

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

ในการพยายามหลีกเลี่ยงปัญหานี้ คุณจะต้องมุ่งเน้นที่การปรับปรุงการค้นพบเอกสารประกอบซอฟต์แวร์ของคุณ

กลยุทธ์แรกคือการแบ่งเอกสารของคุณตามประเภท

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

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

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

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

เครื่องมือเอกสารจำนวนมากมีฟังก์ชันการค้นหาสดในตัว รวมถึง Heroic Knowledge Base

อัปเดตเอกสารซอฟต์แวร์ของคุณอยู่เสมอ

เนื่องจากซอฟต์แวร์ของคุณเปลี่ยนแปลงอยู่เสมอ เอกสารประกอบซอฟต์แวร์ของคุณจึงอยู่ในระหว่างดำเนินการอยู่เสมอ

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

มิฉะนั้น เอกสารของคุณจะไม่ใช่แค่ "ไม่เป็นประโยชน์" เท่านั้น แต่อาจทำให้ผู้ใช้เกิดความสับสนได้

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

ใช้คำติชมของลูกค้าเพื่อปรับปรุงเอกสารของคุณ

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

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

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

ตัวอย่างเช่น ปลั๊กอิน Heroic Knowledge Base ช่วยให้ผู้ใช้ให้คะแนนบทความว่ามีประโยชน์หรือไม่มีประโยชน์ และยัง สามารถเลือก ให้ข้อเสนอแนะในรูปแบบอิสระได้อีกด้วย

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

เริ่มจัดทำเอกสารซอฟต์แวร์ของคุณวันนี้

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

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

คุณอาจมีเอกสารที่แตกต่างกันสำหรับทีมภายในหรือภายนอก รวมถึงสำหรับลูกค้าประเภทต่างๆ เช่น นักพัฒนาเทียบกับผู้ใช้ปลายทาง

หากต้องการสร้างเอกสารที่มีประสิทธิภาพ คุณจะต้องปฏิบัติตามแนวทางปฏิบัติที่ดีที่สุดจากโพสต์นี้

หากต้องการเผยแพร่เอกสารดังกล่าว คุณสามารถใช้เครื่องมือโอเพ่นซอร์ส เช่น Heroic Knowledge Base ซึ่งใช้ซอฟต์แวร์ WordPress อันทรงพลัง

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

หากคุณต้องการเรียนรู้เพิ่มเติม คลิกที่นี่ เพื่อไปที่ Heroic Knowledge Base