Phần mềm Kiến trúc: Làm thế nào để tham khảo Mẫu phần mềm - núm vú

Một phần của kiến ​​trúc phần mềm định hướng hướng đối với người mới bắt đầu Cheat Sheet

Bất cứ khi nào bạn viết tài liệu và muốn tham khảo một mẫu phần mềm, hãy chắc chắn cung cấp cho người đọc của bạn đủ thông tin họ có thể tìm thấy cùng một khuôn mẫu. Các mô hình phần mềm xuất hiện trong sách, tạp chí và quy trình hội nghị, và nên được trích dẫn giống như bất cứ điều gì khác. Dưới đây là một số nguyên tắc:

• Đặt tên. Trong phần thân của tài liệu, làm cho tên mẫu trông khác với văn bản bình thường bằng cách nào đó. Thông thường, các tác giả mô hình thực hiện điều này bằng cách sử dụng định dạng ký tự mũ nhỏ, gạch dưới tiêu đề mẫu hoặc viết hoa nó một cách nhất quán.

• Gắn thẻ mẫu. Đánh dấu mẫu để người đọc có thể tìm thấy mẫu đầy đủ thông qua tham khảo chi tiết. Sử dụng bất kỳ phương pháp tham khảo nào bạn đang áp dụng trong phần còn lại của tài liệu của bạn - chú thích, chú thích, hoặc nội tuyến (với văn bản trong dấu ngoặc đơn).

• Tín dụng tất cả các nguồn của bạn. Đối với mỗi trích dẫn mẫu, hãy bao gồm tất cả tài liệu tham khảo điển hình, chẳng hạn như tác giả, tên mẫu và nơi bạn tìm thấy mẫu (chẳng hạn như sách hoặc trang web). Đôi khi có đủ người biết tài liệu tham khảo để bạn có thể sử dụng một phép viết tắt.

• Ngày phiên bản. Luôn trích dẫn ngày của phiên bản mẫu mà bạn đang sử dụng, đặc biệt là nếu nguồn của bạn có thể được thay đổi và cập nhật. Ví dụ, các mẫu trên trang web có thể được cập nhật dễ dàng. Bởi vì các mẫu văn bản là một quá trình không bao giờ kết thúc, các mẫu được liên tục được tinh chế và các tác giả mô hình liệt kê một ngày mới cho mỗi phiên bản mới.