Bạn có thể coi "tài liệu ngôn ngữ phổ biến" như một dự án tùy biến phần mềm: bạn cần lấy một số phần mềm để quản lý tài liệu và điều chỉnh nó theo nhu cầu cụ thể của bạn. Trong các dự án phần mềm bạn thường bắt đầu với việc thu thập nhu cầu của người dùng, sau đó bạn xây dựng giải pháp thiết kế và kiến trúc thông tin và sau đó bạn tiến hành thực hiện. Dưới đây là ví dụ của quá trình này.
Người dùng cần gì cho nó? Trong một số tổ chức, những người có chức năng khác nhau từ các lĩnh vực khác nhau muốn sử dụng phương ngữ ngôn ngữ chung để mô tả các vấn đề và giải pháp của họ. Phương ngữ này sẽ chỉ được xác định bởi từ vựng của nó (từ và số liệu của lời nói), vì phát âm có lẽ không quan trọng ở đây và ngữ pháp sẽ dựa trên hình thức văn học của ngôn ngữ. Để ghi lại phương ngữ, bạn cần thiết kế một cấu trúc tài liệu phù hợp nhất để quản lý từ vựng (bảng chú giải thuật ngữ).
Mọi người có thể muốn sử dụng tài liệu này để tìm hiểu nghĩa của từ hoặc từ viết tắt, để tìm từ đúng theo từ đồng nghĩa hoặc định nghĩa của nó hoặc để tìm hiểu tất cả các từ tạo ra tên miền.
Đối với những nhu cầu người dùng này, wiki thực sự là một lựa chọn tốt. Làm thế nào nó phù hợp? Trong hệ thống wiki tốt như Confluence hoặc MediaWiki, có thể:
- Tạo một bài viết cho mỗi thuật ngữ.
- Xác định cấu trúc chung của các bài viết trong một số mẫu, sao cho chúng sẽ chứa một số phần chung, có thể được sử dụng để tổng hợp.
- Dễ dàng thêm liên kết đến các định nghĩa thuật ngữ trong các bài viết wiki khác.
- Xây dựng các bảng tổng hợp với các định nghĩa thuật ngữ và nhúng chúng vào tài liệu khác.
Hiện tại tôi đang sử dụng Confluence để ghi lại kiến trúc thông tin và các định nghĩa ngôn ngữ phổ biến là một phần của nó. Cấp độ cao nhất của tài liệu này là các bài viết tên miền. Trong mọi ứng dụng có nhiều tên miền, ví dụ: bảo mật, thanh toán, v.v. Những miền này được xác định bởi một số tương tác của người dùng với hệ thống, có thể được mô tả qua ngôn ngữ phổ biến, vì vậy tôi đặt định nghĩa về các tương tác này trong các trang con và định nghĩa riêng biệt các thuật ngữ được giới thiệu bởi các tương tác này trong các trang con của các trang tương tác. Tôi đặt các bảng tổng hợp trên các trang mẹ để có thể thấy, ví dụ, trong đó các kịch bản bao gồm tên miền và các thuật ngữ được xác định trong đó.
Khi cấu trúc tài liệu này được thực hiện và tôi đi đến các thông số kỹ thuật hệ thống chi tiết hơn, tôi có thể chỉ cần tham khảo các định nghĩa IA và UL của các kịch bản, ví dụ: "thành phần A thực hiện tích hợp với hệ thống B để hỗ trợ tương tác C (liên kết kịch bản IA) bằng cách chuyển thông tin về Z (liên kết UL) ".