Công cụ và tiêu chuẩn cho tài liệu thiết kế kỹ thuật

Question

Tôi muốn biết các công cụ và tiêu chuẩn nào mà các đồng nghiệp của tôi đang sử dụng cho các tài liệu thiết kế kỹ thuật hiện nay.

Trong quá khứ khi ở công ty tôi, chúng tôi chỉ phân phối ứng dụng giành khách hàng-máy chủ, chúng tôi có mẫu từ cho tài liệu thiết kế của mình. Các mẫu của chúng tôi luôn bắt đầu với sơ đồ Cơ sở dữ liệu, sau đó là các giao diện người dùng, ánh xạ trường, mô tả chức năng, v.v ... Với Word và Visio, chúng tôi đã có đủ. Nhưng gần đây chúng tôi đang kết hợp Wikis, sơ đồ UML, công cụ tạo mẫu, v.v. Không có chính sách thực sự mạnh mẽ cho các tiêu chuẩn và công cụ. Bạn có nghĩ là tốt để cung cấp cho các kiến ​​trúc sư tự do lựa chọn bộ công cụ và tiêu chuẩn mà họ thấy phù hợp tại một thời điểm nhất định cho mỗi dự án hay công ty nên thi hành và đứng vững về điều này?

Answer 1

Lý do đằng sau bất kỳ tài liệu thiết kế nào là thông tin liên lạc rõ ràng cho tất cả những người liên quan. Vì vậy, từ quan điểm đó, bất cứ công cụ nào bạn chọn làm một kiến ​​trúc sư lựa chọn, sản phẩm đã hoàn thành cần phải được đọc ngay cả bây giờ bởi tất cả những người liên quan, và sau đó là những người bảo trì. Do đó, có ý nghĩa để chọn ít nhất một số công cụ khá chuẩn, mà vẫn sẽ tồn tại trong vài năm tới.

Điều đó nói rằng, tài liệu thiết kế thường được sử dụng để đưa dự án hoặc hệ thống lên và đi. Sau đó mã tài liệu tốt, và một số tài liệu cơ bản là đủ. Tôi có thể sẽ chú ý nhiều hơn đến việc tổ chức tài liệu của bạn, để mọi người có thể dễ dàng tìm thấy những gì họ đang tìm kiếm trong tương lai. Nó có thể giúp thực thi một số loại cấu trúc/hệ thống kho lưu trữ tiêu chuẩn để lưu trữ tài liệu, nhưng không nhất thiết phải nhấn mạnh vào tất cả các loại mẫu cho tài liệu. Tập trung vào nội dung chứ không phải công cụ.

Answer 2

Trừ khi các dự án của bạn là trình cắt cookie, thì chỉ có ý nghĩa khi áp dụng kết hợp các công cụ tốt nhất cho công việc trong tầm tay. Điều đó nói rằng, một số lỏng lẻo (thô hướng dẫn) hoặc hẹp (áp dụng cho các trường hợp cụ thể) tiêu chuẩn có thể được bảo hành.

Answer 3

Thảo luận kỹ lưỡng giữa các nhà phát triển chính hoặc thành viên nhóm (có thể được ghi lại sau) có giá trị hơn bất kỳ tài liệu nào theo ý kiến ​​của tôi. Cung cấp cho họ tất cả sự tự do để chọn công cụ của họ và yêu cầu họ chỉ viết một bản tóm tắt ngắn về các quyết định kỹ thuật cấp cao từ rất sớm. Đây có thể là nền tảng của tài liệu sau này trong dự án. Một tài liệu thiết kế kỹ thuật đã lỗi thời quá sớm và mất quá nhiều thời gian để viết.

Answer 4

Tôi nghĩ cần có một bộ công cụ và tiêu chuẩn được chỉ định tại thời điểm kiến ​​trúc mô tả cách thiết kế nên được ghi chép. Nó thực sự quan trọng để có một tiêu chuẩn để ghi lại những điều này; bằng không, chúng có khuynh hướng rơi xuống bên lề đường; và nếu tài liệu thiết kế là không đồng nhất, có một mối nguy hiểm mà những người thực sự cần biết nhiều nhất về thiết kế có thể không thể tìm thấy thông tin thiết kế họ thực sự cần khi họ thực sự cần nó.

Điều đó nói rằng, việc lựa chọn các công cụ và tiêu chuẩn hoàn toàn tùy thuộc vào từng tổ chức khác nhau; bất cứ điều gì làm việc cho một tổ chức là phù hợp với họ. Vì vậy, miễn là có sự nhất quán trong các tiêu chuẩn (và các công cụ, ở một mức độ nào đó), bất cứ điều gì được chọn cho một tổ chức cá nhân là phù hợp với chúng. Nó chỉ cần được quyết định và thực thi.