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

ต้องการทราบถึงความสำเร็จเบื้องหลังผลิตภัณฑ์ซอฟต์แวร์ที่ดีและเจริญรุ่งเรืองหรือไม่?

เป็นเอกสารของพวกเขา

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

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

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

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

มาเริ่มกันเถอะ!

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

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

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

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

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

เป็นผลให้เอกสารซอฟต์แวร์ครอบคลุมเอกสารมากมาย จากขั้นตอนการวางแผนไปจนถึงการปฏิบัติตามกฎหมาย

เอกสารบางส่วนที่ผลิตในวงจรการพัฒนาซอฟต์แวร์, แหล่งที่มา - cds.cern.ch

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

1. เอกสารโครงการ

เอกสารโครงการถูกสร้างขึ้นในช่วงเริ่มต้นของการสร้างซอฟต์แวร์และดูแลรักษาตลอดวงจรชีวิต

เนื่องจากให้มุมมองของนกในกระบวนการพัฒนาซอฟต์แวร์จึงช่วยในการตัดสินใจอย่างมาก

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

2. ข้อกำหนดและเอกสารการออกแบบ

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

มันมีส่วนประกอบสำคัญเช่น:

• ภาพรวมของระบบ
• เป้าหมายและวัตถุประสงค์ระดับสูง
• ข้อกำหนดการทำงาน
• เกณฑ์การยอมรับ
• สถาปัตยกรรมระบบ
• สแต็คเทคโนโลยี

ในขณะที่เอกสารความต้องการมุ่งเน้นไปที่สิ่งที่ระบบควรทำเอกสารการออกแบบมุ่งเน้นไปที่วิธีการสร้างระบบ

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

ซอฟต์แวร์จำนวนมากได้รับการออกแบบใหม่ (เช่นเขียนใหม่ในภาษาอื่นหรือโครงสร้างใหม่) เพียงเพราะมันไม่ได้ออกแบบอย่างถูกต้องตั้งแต่แรก

3. เอกสารทางเทคนิค

เอกสารทางเทคนิคครอบคลุมถึงวิธีการสร้างระบบซอฟต์แวร์ดำเนินการและบำรุงรักษา

ในเอกสารซอฟต์แวร์คุณต้องสร้างเอกสารทางเทคนิคเพื่ออธิบาย:

• รหัสทำงานอย่างไร
• APIs (อินเทอร์เฟซการเขียนโปรแกรมแอปพลิเคชัน)
• สคีมาฐานข้อมูล (ตารางความสัมพันธ์และการไหลของข้อมูล)
• วิธีอัพเกรดการพึ่งพาซอฟต์แวร์
• การแก้ไขปัญหาคู่มือ

เรามีคำแนะนำที่สมบูรณ์ในการสร้างและเขียนเอกสารทางเทคนิคลองดูสิ!

4. เอกสารผู้ใช้

เอกสารผู้ใช้ช่วยให้ผู้ใช้ปลายทาง (ลูกค้า) ใช้ซอฟต์แวร์ของคุณอย่างมีประสิทธิภาพ

มันรวมถึง:

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

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

• 5 ตัวอย่างเอกสารผู้ใช้ที่ดีที่สุด (ดี & ไม่ดี + เคล็ดลับ)
• วิธีสร้างคู่มือผู้ใช้: จากศูนย์ถึงฮีโร่ (คู่มือเต็ม)

5. เอกสารการทดสอบ

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

มันรวมถึง:

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

6. เอกสารการบำรุงรักษา / ความปลอดภัย

เอกสารประเภทนี้ช่วยให้นักพัฒนาและทีมสามารถรักษาอัปเดตการดีบักและแก้ไขปัญหาซอฟต์แวร์

มันรวมถึง:

• อัปเดตแนวทางหรือรายการตรวจสอบ
• คำแนะนำในการอัปเดตการพึ่งพาซอฟต์แวร์
• การควบคุมการเข้าถึง
• แผนการ
• บันทึกย่อ

7. เอกสารทางกฎหมายและการปฏิบัติตามกฎระเบียบ

เอกสารทางกฎหมายและการปฏิบัติตามกฎระเบียบเพื่อให้แน่ใจว่าซอฟต์แวร์เป็นไปตามมาตรฐานทางกฎหมายกฎระเบียบและอุตสาหกรรม

เอกสารทางกฎหมายเช่น:

• ข้อตกลงใบอนุญาตผู้ใช้ปลายทาง (EULA)
• ข้อกำหนดในการให้บริการ (TOS)
• นโยบายความเป็นส่วนตัว
• ใบอนุญาตซอฟต์แวร์และข้อมูลการใช้งาน

เอกสารการปฏิบัติตามเช่น:

• การปกป้องข้อมูลและการปฏิบัติตามความเป็นส่วนตัวซึ่งรวมถึงกฎระเบียบเช่น GDPR, CCPA หรือ HIPAA
• การปฏิบัติตามความปลอดภัย
• การปฏิบัติตามความสามารถในการเข้าถึง
• กฎระเบียบเฉพาะอุตสาหกรรม

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

6 ตัวอย่างเอกสารซอฟต์แวร์ที่ดีที่สุดเพื่อเรียนรู้จาก

1. WordPress

โอกาสที่คุณเคยใช้ WordPress มาก่อนดังนั้นนี่อาจเป็นตัวอย่างเอกสารซอฟต์แวร์ที่ดีที่สุดในการเรียนรู้

WordPress ใช้กับ 43% ของเว็บไซต์ทั้งหมดบนเว็บ ดังนั้นเอกสารของมันจะต้องเป็นหนึ่งในสิ่งที่ดีที่สุดในการให้บริการผู้คนนับล้านจากทั่วทุกมุมโลก

ซึ่งรวมถึงนักพัฒนานักออกแบบบล็อกเกอร์นักเขียนหรือใครก็ตามที่ต้องการสร้างเว็บไซต์

เอกสารหลักของ WordPress แบ่งออกเป็นสามส่วนที่แตกต่างกัน :

1. เรียนรู้ WordPress: รวมคำแนะนำในรูปแบบของหลักสูตรเชิงลึกวิดีโอและบทเรียนการเขียน กำหนดเป้าหมายไปยังผู้เริ่มต้นผู้ใช้ระดับกลางและขั้นสูง
2. เอกสารหลัก: มุ่งเป้าไปที่ผู้ใช้ปกติ เพื่อให้ภาพรวมของคุณสมบัติ WordPress ในรูปแบบของบทเรียนที่เขียนตรงไปตรงมาสั้น ๆ
3. ทรัพยากรนักพัฒนา: มุ่งเป้าไปที่นักพัฒนาที่สร้างธีม WordPress ปลั๊กอินหรือต้องการขยาย WordPress ด้วยการเข้ารหัสที่กำหนดเอง มันรวมถึงคู่มือเริ่มต้นเอกสาร API และตัวอย่างการเข้ารหัส

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

สิ่งที่ควรเรียนรู้จากเอกสารซอฟต์แวร์ WordPress:

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

สิ่งที่ไม่ชอบเกี่ยวกับเอกสาร WordPress:

• ไม่มีเอกสารหลายภาษา แม้ว่าคุณจะสามารถค้นหาคำแนะนำ WordPress ของบุคคลที่สามในภาษาของคุณได้อย่างง่ายดาย แต่ฉันหวังว่า WordPress ได้สร้างบทเรียนสำหรับภาษายอดนิยม

2. ฐานความรู้ Herothemes

เอกสารซอฟต์แวร์ของเราเอง

ไม่ใช่ตัวอย่างที่ดีที่สุด แต่เนื่องจากคุณส่วนใหญ่มีสถานการณ์ที่คล้ายกันกับเรา:

• ไม่รู้ว่าจะเริ่มต้นตรงไหน
• งบประมาณต่ำ

มันอาจเป็นตัวอย่างที่ดีในการเรียนรู้จาก

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

สิ่งที่ต้องเรียนรู้จากตัวอย่างเอกสาร Herothemes:

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

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

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

สิ่งที่ไม่ชอบเกี่ยวกับเอกสาร Herothemes:

เนื่องจาก Herothemes นำเสนอโซลูชั่นซอฟต์แวร์หลายอย่าง การจัดกลุ่มเนื้อหาเอกสารจึงเป็นเรื่องเล็กน้อย

เรามีคำแนะนำบางอย่างเพื่อช่วยคุณสร้างเว็บไซต์เอกสารด้วย WordPress:

• วิธีสร้างฐานความรู้ WordPress (คู่มือทีละขั้นตอน)
• วิธีสร้างเอกสารภายใน

3. เอกสารพอร์ตโฟลิโอซอฟต์แวร์ Barn2

Barn2 ขายผลิตภัณฑ์ซอฟต์แวร์หลายรายการตาม WordPress และ WooCommerce ที่ใช้กับเว็บไซต์กว่า 90,000 เว็บไซต์

การให้บริการเอกสารซอฟต์แวร์หลายรายการจากพอร์ทัลเดียวอาจเป็นเรื่องที่ท้าทาย แต่ Barn2 ทำได้อย่างสวยงาม

คุณควรดูตัวอย่างของ Barn2 อย่างแน่นอนหากคุณมีหลายผลิตภัณฑ์

สิ่งที่ต้องเรียนรู้จากตัวอย่างเอกสาร Barn2:

Barn2 สร้างหน้าสนับสนุนของพวกเขาอย่างระมัดระวัง ซึ่งสามารถเห็นได้ด้วยฟังก์ชั่นโดยรวมและประโยชน์

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

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

เมื่อการค้นหาล้มเหลวในการให้ผลลัพธ์ใด ๆ มันจะแสดงวิธีการสนับสนุนมนุษย์

พูดคุยเกี่ยวกับเอกสารซอฟต์แวร์หลัก:

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

สิ่งที่ไม่ชอบเกี่ยวกับเอกสารของ Barn2:

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

Barn2 ยังใช้ ฐานความรู้ที่กล้าหาญ เพื่อสร้างเอกสารซอฟต์แวร์ของพวกเขา

4. คู่มือผู้ใช้ iPhone

มีหลายสิ่งที่ชอบและไม่ชอบเกี่ยวกับเอกสารผู้ใช้ของ iPhone (คู่มือซอฟต์แวร์ iOS)

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

สิ่งที่ต้องเรียนรู้จากตัวอย่างเอกสารของ iPhone:

เอกสาร iPhones ดู น่าทึ่ง

• เค้าโครงคอลัมน์เดียว
• พื้นที่สีขาวมากมาย
• ย่อหน้าและเนื้อหาเล็ก ๆ
• ภาพที่สวยงาม
• การใช้หัวเรื่องรายการและตัวแบ่ง

จุดสนใจส่วนใหญ่ของเอกสารของพวกเขาคือการสร้างคู่มือที่น่าทึ่งและเป็นประโยชน์เช่นนี้

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

เอกสารของ iPhone ถูกสร้างขึ้นเป็นพิเศษด้วยวิธีนี้เพื่อให้ทุกคนสามารถเข้าใจได้ง่าย

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

นอกเหนือจากการตกแต่งเอกสารของพวกเขาแล้ว Apple ไม่ลืม ใช้ SEO อย่างถูกต้อง เพื่อเฉพาะเจาะจง:

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

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

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

Apple ยัง ให้คำแนะนำตามเวอร์ชันซอฟต์แวร์ (ในกรณีนี้เวอร์ชัน iOS)

สิ่งที่ไม่ชอบเกี่ยวกับเอกสาร iPhone:

ฉัน ชื่นชม มากเกี่ยวกับเอกสารของ iPhone ด้านบน แต่ก็มีบางสิ่งที่น่ารำคาญ

โดยเฉพาะอย่างยิ่งส่วนการนำทาง

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

5. เอกสารการออกแบบซอฟต์แวร์ (ตัวอย่างภายใน)

เอกสารซอฟต์แวร์เริ่มต้นจากแนวคิดในการสร้างซอฟต์แวร์ใด ๆ

ตัวอย่างเช่นเอกสารซอฟต์แวร์เริ่มต้นของคุณอาจรวมถึง:

• ความต้องการจากซอฟต์แวร์คืออะไร
• ขอบเขต
• มันจะทำงานอย่างไร
• การอ้างอิง

การมีข้อมูลโดยละเอียดจะช่วยหลีกเลี่ยงการประชุมในอนาคตฝึกอบรมพนักงานใหม่และสร้างแนวทางที่เป็นรูปธรรม

คุณสามารถเรียนรู้มากมายจากเอกสารการออกแบบซอฟต์แวร์ที่ปรึกษาการเดินทางบนถนน

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

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

สิ่งที่ต้องเรียนรู้จากตัวอย่างนี้:

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

6. เอกสารของ Google

ใครไม่รู้จัก Google? เราใช้ซอฟต์แวร์ชั้นนำของพวกเขาทุกวันเช่น Chrome, Gmail, Google Maps, Google Drive หรือ YouTube

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

ในสถานการณ์เช่นนี้จะต้องเป็น ฝันร้าย ที่จะสร้างสิ่งที่ดีโดยไม่ยุ่ง และ Google ทำงานได้ดีมากกับเอกสารของพวกเขา

สิ่งที่ต้องเรียนรู้จากเอกสารซอฟต์แวร์ของ Google:

• การใช้แท็บและหีบเพลงที่ยอดเยี่ยม เพื่อทำให้กลุ่มเนื้อหาง่ายขึ้น

หากคุณสร้างซอฟต์แวร์สำหรับอุปกรณ์หลายตัวนี่คือวิธีที่คุณสามารถหลีกเลี่ยงการสร้างเอกสารหลายฉบับ

• ระบบตอบรับที่ยอดเยี่ยม เช่นเดียวกับตัวอย่างข้างต้นบางส่วน Google ยังมีระบบตอบรับใช่/ไม่ใช่ที่รวบรวมข้อเสนอแนะจากผู้ใช้

แต่ Google ก้าวไปอีกขั้นหนึ่งที่นี่ พวกเขามีระบบในสถานที่ที่รวบรวม ข้อเสนอแนะตามส่วนที่เฉพาะเจาะจง ซึ่งใช้งานง่ายและมีประโยชน์มาก

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

สิ่งที่ไม่ชอบเกี่ยวกับเอกสารของ Google:

ฉันพยายามหาอะไรมากมายที่จะบ่นเกี่ยวกับที่นี่ แต่ในที่สุดฉันก็ทำไม่ได้ Google Sure มีเอกสารซอฟต์แวร์ที่ดี

ความคิดสุดท้าย

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

นี่คือคำสุดท้าย:

1. เมื่อคุณ เริ่มต้นด้วยการสร้างซอฟต์แวร์ ให้สร้างคู่มือภายในที่จะร่างวัตถุประสงค์ของซอฟต์แวร์ขอบเขตการทำงานและเกณฑ์การเปิดตัว
2. สร้างพอร์ตโฟลิโอเอกสารของคุณ ในขณะที่คุณพัฒนาซอฟต์แวร์ ตัวอย่างเช่นเอกสาร API และเอกสารทางเทคนิค
3. ก่อนที่จะเปิดตัวซอฟต์แวร์ ให้สร้างเอกสารผู้ใช้ที่มีคู่มือการตั้งค่าใช้เคส, ภาพรวมฟังก์ชันการทำงานและคำถามที่พบบ่อย
4. หลังจากเปิดตัว ให้สร้างบทเรียนเพื่อแก้ไขปัญหาผู้ใช้ที่พบบ่อยที่สุดและปรับปรุงเอกสารเก่าของคุณ

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

หากคุณกำลังมองหา โซลูชันเอกสารซอฟต์แวร์ ฐานความรู้ฮีโร่ มีทุกสิ่งที่เราได้กล่าวถึงในคู่มือนี้

ลองดูสิ!