Tiêu đề nói lên tất cả.
Đôi khi nó có thể kết thúc rằng sự phát triển và CNTT đang đứng đầu trong lĩnh vực này. Cấp độ tài liệu nào bạn mong đợi khi bạn dự kiến cài đặt, vá, bảo trì, bắt đầu, dừng và chẩn đoán một giải pháp chạy trên một hoặc nhiều máy chủ?
Câu trả lời:
Tất cả những điều này nên được ghi lại một cách chi tiết, mặc dù khi hoạt động là tiêu chuẩn cho hệ điều hành, máy chủ ứng dụng, máy chủ web, v.v. bạn có thể giả định rằng các hoạt động CNTT mọi người biết cách làm điều đó.
Cài đặt: ghi lại mọi thứ về cách nó được cài đặt và cấu hình, bao gồm cả cách nhận biết nó có hoạt động chính xác không.
Hãy cho chúng tôi biết về kiến trúc, đặc biệt là về giao tiếp giữa các thành phần giải pháp khác nhau (ví dụ: phạm vi cổng - cơ chế RPC thường sử dụng một loạt các cổng - chúng tôi cần biết phạm vi đó là gì và khi nào ứng dụng có thể hết cổng).
Vá: ghi lại bất cứ điều gì cụ thể cho ứng dụng - những gì cần phải tắt trước khi vá và bất kỳ hành động tiếp theo nào sau khi vá (cache, chỉ mục, proxy có thể cần phải xóa hoặc xây dựng lại).
Bảo trì: ghi lại hoạt động bình thường và bất thường trông như thế nào - hàng đợi và những thứ khác cần được theo dõi và phạm vi bình thường của những điều này là gì.
Hãy cho chúng tôi biết cách quản lý dữ liệu - đặc biệt là các bảng và tệp phát triển không giới hạn (ví dụ: tệp nhật ký và lịch sử giao dịch). Làm thế nào những thứ này nên được thanh trừng và tác động của việc loại bỏ các mục cũ? (về báo cáo vv).
Hãy cho chúng tôi biết cách thực hiện các hoạt động quản lý "kinh doanh bình thường" / trong cuộc sống tiêu chuẩn - ví dụ, đây có thể là thêm hoặc sửa đổi tài khoản người dùng.
Hãy cho chúng tôi biết về bất kỳ hành động quản lý thông thường nào khác có thể được yêu cầu (ví dụ: chứng chỉ nào được sử dụng và phải làm gì khi hết hạn).
Đối với tất cả các thay đổi, hãy cho chúng tôi biết cách khôi phục chúng (không phải tất cả các thay đổi đều thành công). Và nói với chúng tôi rằng bạn đã thử nghiệm các kế hoạch rollback!
Chẩn đoán: Định dạng và vị trí tệp nhật ký tài liệu và MỌI thông báo lỗi ứng dụng có thể bật lên, cho biết thông báo lỗi có nghĩa là gì sai và những gì có thể cần phải thay đổi để sửa nó. Không bao giờ sử dụng cùng một thông báo lỗi cho hai sự kiện khác nhau.
Bắn xuống và khởi động: Làm thế nào, thứ tự nào, bất kỳ thủ tục đặc biệt nào (ví dụ: để máy chủ thoát kết nối trước khi tắt chúng).
Tôi hoàn toàn không đồng ý rằng cách tốt nhất để làm việc này là ném ứng dụng qua hàng rào và để dân IT làm việc những gì cần thiết. Các tài liệu hoạt động (và nói chung, các tính năng quản lý của ứng dụng) cần phải được suy nghĩ trước.
Một câu hỏi tiếp theo sẽ là: điều gì xảy ra khi (chứ không phải) các nhà phát triển không cung cấp đủ tài liệu?
Tôi khuyên rằng CNTT có khả năng nhập các báo cáo lỗi đối với phần mềm, sử dụng bất kỳ hệ thống theo dõi lỗi nào mà các nhà phát triển sử dụng. Bằng cách đó, nếu họ không nói với bạn, chẳng hạn, các tệp trong một thư mục cụ thể cần phải được thanh lọc và chỉ nên giữ giá trị trong một tuần, bạn có thể nhập vào một lỗi nói rằng "ứng dụng sẽ lấp đầy đĩa bằng các tệp nhật ký ", Và đề nghị họ làm việc với CNTT về một kỹ thuật được lập thành tài liệu để xóa thư mục đó.
Danh sách các yêu cầu của tôi đối với tài liệu sẽ là (không theo thứ tự cụ thể nào):
(tài liệu về :)
Tài liệu như thế này là ví dụ cho tài liệu tốt:
Tôi coi tài liệu như thế này là đầy thất bại:
Ngoài ra, Cẩm nang FreeBSD là một ví dụ tuyệt vời về tài liệu và cách tiếp cận của OpenBSD. Họ đá những thứ không đúng tài liệu.
EDIT: danh sách này không có nghĩa là hoàn thành, nó chỉ là những thứ cơ bản ngay lập tức xuất hiện trong đầu tôi. Ngoài ra các tài liệu nên được đọc tốt, không chỉ là một cái gì đó đọc như ai đó đã ném lên .
Tóm lại, tôi mong đợi các tài liệu tôi chỉ định và hợp đồng cho.
Quá nhiều lần chi tiết quan trọng này bị bỏ qua một thỏa thuận. Người dùng cuối mong đợi nó và tất nhiên muốn nó miễn phí. Các nhà phát triển giỏi sẽ điều chỉnh sự giám sát này sớm trong quá trình và đặt kỳ vọng bao gồm yêu cầu về giá cả và thời gian.
Tôi tin rằng CNTT cần liên lạc với các nhà phát triển loại tài liệu nào là cần thiết. Cách tốt nhất để làm điều này là nếu sự phát triển cung cấp các phiên bản tiền phát hành (hoặc phiên bản lặp) của một giải pháp để CNTT chơi và thử nghiệm để CNTT có thể đáp ứng với những gì cần thiết.
@Spoike (Tôi chưa thể nhận xét về câu trả lời ..)
Những người triển khai CNTT (vai trò sẽ thay đổi theo loại hình và quy mô doanh nghiệp) phải hoạt động nhất quán để đạt được những điều sau:
Cài đặt / doanh thu Yêu cầu tối thiểu - nói cách khác, CNTT không thể thụ động và mong các nhà phát triển "biết" thông tin nào là cần thiết trong thời gian cài đặt / doanh thu. Tôi đã thấy rằng thường có sự nhầm lẫn / bất đồng đáng kể trong CNTT về những gì cấu thành tài liệu thích hợp của một ứng dụng. Dev hiểu các yêu cầu (chúng tôi hy vọng) và CNTT phải tập trung để tìm ra những gì - ở mức tối thiểu - là bắt buộc.
Quy trình cài đặt / doanh thu - trong cài đặt doanh nghiệp, bạn có thể gọi đây là Kiểm soát thay đổi hoặc Quản trị, nhưng về cơ bản, đó là một chu trình đánh giá tiêu chuẩn trong đó CNTT ngồi xuống với bản cài đặt hàng đầu của Dev PRIOR để có bản tóm tắt về sản phẩm và nhu cầu của nó.
Cài đặt một ứng dụng không giống như ra mắt một sản phẩm sân khấu. Trước khi màn hạ màn, đạo diễn (nhà phát triển chính) gặp gỡ nhiều lần với đội ngũ sản xuất sân khấu (người triển khai CNTT) để đảm bảo mọi thứ đều "chỉ như vậy" cho đêm khai mạc (cài đặt công khai).
Bạn không thể thay đổi Dev persona (tại sao bạn muốn?), Nhưng bạn có thể chỉ ra mục tiêu được chia sẻ của mình về một ứng dụng tuyệt vời chạy rất nhanh cho tất cả người dùng. Sự đồng thuận của bạn yêu cầu tài liệu CNTT chỉ là một trong những điều cần thiết để đảm bảo điều đó.