ใช่ แต่สุดท้ายแล้ว:
- การเชื่อมโยง rotจะเป็นปัญหาสร้างการเชื่อมโยงแบบไดนามิกจากเอกสารเป้าหมายที่รู้จัก แต่รับส่วนนำหน้าจากการกำหนดค่าบางรูปแบบ หากเซิร์ฟเวอร์เปลี่ยนไปคุณสามารถใช้รหัสที่เก่ากว่าได้โดยอัปเดตองค์ประกอบการกำหนดค่านี้ นอกจากนี้คุณยังสามารถทำให้เอกสารอยู่ในเครื่องได้เพียงแค่เปลี่ยนการกำหนดค่าคำนำหน้านี้
- การกำหนดเวอร์ชัน : ด้วยจิตวิญญาณเดียวกันหากคุณสามารถรวมการกำหนดเวอร์ชันไว้ในลิงก์ในบางส่วนเพื่อให้ลิงก์ชี้ไปยังเอกสารเวอร์ชันที่ถูกต้องเสมอ
- จัดทำเอกสารแก้ไขได้บางอย่างเช่นไซต์ประเภท wiki สำหรับเอกสารของคุณซึ่งคุณสามารถแก้ไขข้อผิดพลาดแบบไดนามิกได้นอกจากนี้ยังช่วยให้ผู้ใช้สามารถแสดงความคิดเห็นได้โดยตรงบนหน้าเว็บ สิ่งนี้จะช่วยให้ผู้ใช้ของคุณเข้าร่วมและค้นหาสิ่งที่ต้องการได้ง่ายขึ้นและคุณจะได้รับข้อมูลทองเพื่อให้เอกสารของคุณอยู่ในสภาพที่ใช้งานได้ แต่ให้แน่ใจว่าคุณตรวจสอบเป็นประจำและส่วนใหญ่เข้าร่วมด้วยตนเอง
- แม่แบบที่สร้างขึ้นมีระบบสร้างของคุณสร้างแม่แบบพื้นฐานสำหรับเอกสารจากหมายเหตุประกอบในรหัสโดยตรง ทำให้เรียบง่าย แต่สิ่งนี้จะทำให้มั่นใจได้ว่าทุกลิงก์จะชี้ไปยังเอกสารที่ถูกต้องเสมอ หากคุณใช้วิกิให้แน่ใจว่าคุณสามารถผลักแม่แบบเหล่านี้ได้อย่างง่ายดายและตรวจสอบให้แน่ใจว่าคุณสามารถโปรโมตไซต์เอกสารในลักษณะเดียวกับที่คุณทำกับโค้ดของคุณ (มีไซต์ dev ซึ่งแตกต่างจากไซต์แยงและโปรโมตโค้ด ดำเนินการแทรกในเว็บไซต์ prod โดยอัตโนมัติ)
หากคุณพัฒนาด้วย Java หรือ. NET เอกสารอาจรวมอยู่ในไฟล์ jar หรือไฟล์ DLL และโดยการเปลี่ยนคำนำหน้ารหัสของคุณสามารถดึงข้อมูลได้ในเครื่องแทน
ถ้าคุณเลือกวิธี wiki ฉันแนะนำDokuWikiอย่างอบอุ่นสำหรับความเรียบง่ายและความจริงมันขึ้นอยู่กับไฟล์ข้อความแบบแบนซึ่งจะทำให้เป็นมิตรกับการฉีดอัตโนมัติจากระบบสร้าง ที่กล่าวว่าฉันไม่ทราบเกี่ยวกับสภาพแวดล้อมหรือลูกค้าของคุณพอที่จะรู้ว่านี่จะเหมาะกับ YMMV หรือไม่
เครื่องมือที่ประสบความสำเร็จสูงสุดบางอย่างที่ฉันสร้างขึ้นนั้นใช้วิธีการที่คล้ายกันซึ่งข้อความแสดงข้อผิดพลาดถูกกำหนดเป้าหมายไปยังผู้ใช้จริงที่น่าจะปฏิบัติงานได้มากที่สุด นั่นหมายความว่าฉันต้องทำข้อยกเว้นมากมายในการจับและตัดเพื่อให้แน่ใจว่าข้อผิดพลาดอยู่ในระดับที่เหมาะสมของนามธรรม ฉันยังแน่ใจด้วยว่าข้อความแสดงข้อผิดพลาดแต่ละรายการจะรวมถึงแหล่งที่มาของข้อผิดพลาดและชี้ไปที่วิธีแก้ปัญหาที่เป็นไปได้ "คุณลืมตั้งค่า xxxx config หรือไม่", "ตรวจสอบให้แน่ใจว่า xxx และ yyy ที่ XXX และ whatnot จะถูกสร้างขึ้นจากบริบทที่เกิดข้อผิดพลาด
วิธีนี้ค่อนข้างง่าย แต่ก็มีข้อ จำกัด มากกว่า อย่างไรก็ตามมีข้อดีที่ว่าเอกสารจะมีอยู่เสมอเมื่อไม่ต้องการการเชื่อมโยงที่เน่า
แนวทางของคุณคือวิวัฒนาการต่อไป ซับซ้อนมากขึ้น แต่ก็มีผลตอบแทนที่เป็นไปได้อีกมาก มันจะมีค่าใช้จ่ายสูง แต่ถ้าทำถูกต้องจะจ่ายให้เองได้ง่าย