Trả lời nhanh: Sáu thứ tối thiểu: sơ đồ hệ thống, danh sách máy và vai trò, thông tin truy cập cất trong kho bí mật, quy trình xử lý bốn sự cố hay gặp nhất, thông tin liên hệ nhà cung cấp, và lịch bảo trì. Cất ở nơi vẫn lấy được khi hệ thống chính đã sập, kèm một bản in cho trường hợp xấu nhất.
Tài liệu vận hành là thứ ai cũng đồng ý là cần và gần như không ai làm, cho tới lần đầu tiên có sự cố lúc hai giờ sáng mà người biết hệ thống đang đi công tác. Bài này đưa ra bộ tài liệu tối thiểu, đủ nhỏ để thực sự làm được.
Sáu thứ tối thiểu phải có
- Sơ đồ hệ thống. Không cần đẹp, một hình vẽ tay chụp lại cũng được. Cần thể hiện: máy nào chạy gì, chúng nối với nhau ra sao, dữ liệu đi từ đâu tới đâu.
- Danh sách máy và vai trò. Tên máy, địa chỉ mạng, chạy dịch vụ gì, ai phụ trách, đặt ở đâu, cấu hình ra sao.
- Thông tin truy cập. Không viết mật khẩu vào tài liệu. Ghi nơi cất chúng và ai có quyền lấy.
- Quy trình xử lý sự cố cho bốn tình huống hay gặp nhất của chính hệ thống bạn.
- Liên hệ nhà cung cấp. Số hợp đồng, kênh mở yêu cầu hỗ trợ, thời gian phản hồi cam kết, số điện thoại khẩn.
- Lịch bảo trì và lịch hết hạn. Chứng chỉ, tên miền, giấy phép phần mềm, hợp đồng thuê, bảo hành phần cứng.
Sáu thứ này viết trong một buổi là xong bản đầu tiên. Đừng chờ tới khi có thời gian làm cho đẹp, vì thời gian đó không bao giờ tới.
Cất ở đâu
Đây là chi tiết quyết định tài liệu có dùng được lúc cần hay không.
Nguyên tắc: tài liệu phải truy cập được khi hệ thống mà nó mô tả đã sập. Cất tài liệu vận hành trên chính máy chủ nội bộ là một sai lầm kinh điển.
Ba nơi hợp lý, dùng đồng thời:
- Một dịch vụ ghi chú trên đám mây mà cả đội truy cập được từ điện thoại. Đây là bản chính dùng hằng ngày.
- Bản kết xuất định kỳ tải về máy của mỗi người phụ trách, phòng khi dịch vụ đám mây cũng có sự cố.
- Một bản in cho các thông tin sống còn: sơ đồ, liên hệ khẩn, quy trình bốn sự cố chính. Cất trong tủ tại văn phòng. Nghe lỗi thời nhưng đây là thứ duy nhất dùng được khi mất cả mạng lẫn điện.
Về mật khẩu, dùng một kho bí mật dùng chung của đội. Tuyệt đối không để chúng trong bảng tính hay trong tài liệu, và cũng đừng để chúng chỉ nằm trong đầu một người.
Quy trình xử lý sự cố
Đây là phần giá trị nhất và cũng khó viết nhất. Đừng cố viết cho mọi tình huống, hãy chọn bốn tình huống thực tế đã xảy ra hoặc chắc chắn sẽ xảy ra.
Với mỗi tình huống, viết bốn phần:
- Dấu hiệu nhận biết. Cảnh báo nào, người dùng phàn nàn gì.
- Kiểm tra nhanh. Ba tới năm việc kiểm theo thứ tự, để xác định đúng nguyên nhân.
- Cách xử lý. Các bước cụ thể, gồm cả lệnh nếu có.
- Khi nào thì leo thang. Sau bao lâu không xử lý được thì gọi ai.
Bốn tình huống nên viết đầu tiên với phần lớn hệ thống: một máy chủ không phản hồi, đĩa đầy, dịch vụ chính không truy cập được, và cần phục hồi dữ liệu từ bản sao lưu.
Mẹo viết nhanh: lần tới khi có sự cố thật, vừa xử lý vừa ghi lại các bước. Sau ba tháng bạn có bộ quy trình dựa trên tình huống thật, giá trị hơn nhiều so với ngồi tưởng tượng.
Giữ cho tài liệu không lỗi thời
Tài liệu sai còn nguy hiểm hơn không có tài liệu, vì người đọc tin vào nó.
Bốn thói quen giữ nó sống:
- Cập nhật ngay khi thay đổi, coi đó là một bước bắt buộc trong mọi thay đổi hệ thống, không phải việc làm sau.
- Ghi ngày cập nhật cuối ở đầu mỗi phần. Người đọc cần biết thông tin này cũ tới đâu.
- Rà toàn bộ mỗi sáu tháng. Đặt lịch nhắc. Mỗi lần rà mất một buổi và luôn phát hiện vài chỗ đã sai.
- Kiểm bằng người mới. Đưa tài liệu cho một người chưa biết hệ thống và nhờ họ làm theo một quy trình. Chỗ nào họ vướng là chỗ tài liệu thiếu.
Viết cho ai đọc
Hãy viết cho một người có kỹ năng kỹ thuật nhưng chưa biết hệ thống của bạn, đang đọc lúc hai giờ sáng trong trạng thái căng thẳng.
Bốn hệ quả về cách viết:
- Ngắn và cụ thể. Câu lệnh chính xác tốt hơn mô tả dài dòng.
- Đừng giả định kiến thức riêng của bạn. Đừng viết như mọi người đã biết, hãy ghi thẳng ra.
- Nói cả lý do. Một câu giải thích vì sao làm bước này giúp người đọc xử lý được cả những tình huống lệch khỏi quy trình.
- Đánh dấu chỗ nguy hiểm. Bước nào không thể quay lui, bước nào làm dừng dịch vụ, ghi rõ ngay tại đó.
Và một điều đáng nhớ: người đọc tài liệu này lúc nửa đêm nhiều khả năng chính là bạn của sáu tháng sau, khi đã quên hết. Viết cho chính mình lúc đó.
Bảng sáu mục tối thiểu của tài liệu vận hành
| Mục | Nội dung | Vì sao |
|---|---|---|
| Sơ đồ hệ thống | Máy nào chạy gì, nối với nhau ra sao | Người xử lý sự cố lúc nửa đêm cần biết mình đang đứng ở đâu |
| Danh sách truy cập | Địa chỉ, cổng, cách vào từng máy | Không có nó thì không bắt đầu xử lý được |
| Quy trình khôi phục | Các bước khôi phục từ bản sao lưu, đã thử thật | Đây là tài liệu quan trọng nhất và ít được thử nhất |
| Danh bạ liên hệ | Nhà cung cấp, nhà mạng, người phụ trách, kèm số điện thoại thật | Số tổng đài giờ hành chính không dùng được lúc 2 giờ sáng |
| Lịch bảo trì | Việc gì làm định kỳ, ai làm, lần cuối làm khi nào | Để việc định kỳ không phụ thuộc trí nhớ của một người |
| Nhật ký thay đổi | Ai đổi gì, ngày nào, vì sao | Khi hệ thống hỏng, câu hỏi đầu tiên luôn là gần đây có đổi gì không |
Cất ở đâu, và cái bẫy hiển nhiên
# Cai bay: cat tai lieu van hanh TREN chinh he thong ma no mo ta.# He thong chet la mat luon huong dan sua he thong. # Nguyen tac: tai lieu phai truy cap duoc khi moi thu khac da chet. # Bo ba nen co:# 1. Ban chinh o noi ca doi cung sua duoc, co lich su thay doi# 2. Ban sao ngoai tuyen, vi du tep PDF tren may cua nguoi truc# 3. Ban in cho phan quan trong nhat: cach vao va cach khoi phuc # Ve mat khau: KHONG viet trong tai lieu van hanh.# Dung kho mat khau rieng, va trong tai lieu chi ghi# mat khau nam o dau va ai co quyen mo. # Kiem tra thuc te, lam mot lan moi nam:# Dua tai lieu cho mot nguoi trong doi CHUA tung xu ly he thong nay,# yeu cau ho lam theo de khoi phuc mot dich vu trong moi truong thu.# Cho nao ho phai hoi la cho tai lieu con thieu.Cập nhật ngay trong lần thay đổi
- Cập nhật ngay trong lần thay đổi, không để dồn. Coi việc sửa tài liệu là một phần của việc thay đổi hệ thống, chưa sửa thì việc chưa xong.
- Ghi ngày cập nhật cuối lên đầu mỗi trang. Người đọc cần biết mình đang tin vào thứ cũ tới mức nào.
- Rà lại mỗi quý và mạnh dạn xóa phần đã lỗi thời. Tài liệu sai còn nguy hiểm hơn không có tài liệu, vì nó dẫn người ta đi sai hướng lúc đang gấp.
- Viết cho người chưa quen hệ thống. Người viết luôn nghĩ mọi thứ hiển nhiên, còn người đọc lúc hai giờ sáng thì không.
Câu hỏi thường gặp
Nên dùng công cụ gì để viết
Thứ mà cả đội thực sự mở hằng ngày. Một trang trong công cụ ghi chú của công ty tốt hơn một hệ thống tài liệu chuyên nghiệp mà không ai vào. Yêu cầu duy nhất là truy cập được từ ngoài mạng công ty và từ điện thoại.
Bao nhiêu là đủ
Bắt đầu bằng sáu nhóm ở phần đầu, khoảng vài trang. Thêm dần khi gặp tình huống mà tài liệu chưa có câu trả lời. Tài liệu quá dài không ai đọc cũng vô dụng như tài liệu không có.
Ai chịu trách nhiệm viết
Người vận hành hệ thống, không phải người quản lý. Nhưng người quản lý nên coi đây là một phần công việc chứ không phải việc làm thêm khi rảnh, và nên dành thời gian cụ thể cho nó trong kế hoạch.
Có nên đưa sơ đồ mạng chi tiết vào không
Có, nhưng lưu ý đây là thông tin nhạy cảm. Giới hạn quyền truy cập tài liệu, và với bản in thì cất trong tủ có khóa. Đừng vì lo bảo mật mà không viết, chỉ cần kiểm soát ai xem được.