วิธีการจัดทำเอกสารภาษาที่แพร่หลาย

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

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

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

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

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

ผู้คนอาจต้องการใช้เอกสารนี้เพื่อเรียนรู้ความหมายของคำหรือตัวย่อเพื่อค้นหาคำที่ถูกต้องโดยคำพ้องความหมายหรือคำนิยามหรือเพื่อเรียนรู้คำศัพท์ทั้งหมดที่เขียนในโดเมน

สำหรับความต้องการของผู้ใช้เหล่านี้ย่อมเป็นทางเลือกที่ดี มันเหมาะสมอย่างไร ในระบบ wiki ที่ดีเช่น Confluence หรือ MediaWiki มันเป็นไปได้ที่:

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

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

เมื่อโครงสร้างเอกสารนี้เสร็จสิ้นและฉันไปที่รายละเอียดทางเทคนิคของระบบฉันสามารถอ้างถึงคำจำกัดความของ IA และ UL ของสถานการณ์เช่น "องค์ประกอบ A ดำเนินการรวมกับระบบ B เพื่อสนับสนุนการโต้ตอบ C (ลิงค์สถานการณ์จำลอง IA) โดยการส่งข้อมูลเกี่ยวกับ Z (ลิงก์ UL) "