Viết runbook sự cố để đồng đội có thể làm theo

Runbook sự cố là hướng dẫn vận hành ngắn cho một dạng lỗi có thể nhận diện. Người đọc có thể thiếu ngữ cảnh và không có nhiều thời gian. Tài liệu cần giúp họ chọn bước tiếp theo an toàn, thay vì cố tái hiện trí nhớ của tác giả. Hãy bắt đầu bằng một triệu chứng lặp lại và một ranh giới dịch vụ rõ, không phải cuốn sổ tay bao quát mọi gián đoạn.

Cho người đọc biết khi nào áp dụng

Mở đầu bằng triệu chứng người dùng thấy, chức năng bị ảnh hưởng và điều kiện khiến hướng dẫn này không phù hợp. Giải thích quyền cần có nhưng không ghi thông tin đăng nhập. Nêu vai trò phụ trách và đường chuyển cấp. Trước khi thay đổi hệ thống, đồng đội cần biết nên tiếp tục, nhờ hỗ trợ hay dừng lại.

Hướng dẫn quản lý sự cố của Google khuyến nghị chuẩn bị quy trình thành văn với sự tham gia của những người xử lý sự cố.[3] Hãy áp dụng nguyên tắc đó bằng cách mời bộ phận hỗ trợ và chủ dịch vụ rà soát. Câu hỏi của họ thường làm rõ ngữ cảnh nghiệp vụ mà tác giả kỹ thuật coi là hiển nhiên.

Ghép hành động với điều cần quan sát

Với từng hành động được phê duyệt, nêu mục đích, quyền cần có, kết quả mong đợi và điều kiện dừng. Tách chẩn đoán khỏi thay đổi. Nếu quan sát khác dự kiến, hướng dẫn người đọc chuyển cấp thay vì tự ứng biến sửa chữa.

Mô tả cách giữ bằng chứng liên quan và ghi quyết định. Trong tài liệu vận hành thật, có thể dẫn tới quy trình nội bộ được kiểm soát, nhưng không chép chi tiết kết nối nhạy cảm vào bản chia sẻ rộng. Bản mô tả công khai vẫn có thể giải thích trách nhiệm mà không lộ hệ thống.

Ví dụ giả định: nhãn kho bị chậm

Trong ví dụ giả định này, nhân viên kho báo yêu cầu tạo nhãn cứ ở trạng thái chờ. Runbook trước hết hỏi hệ thống có nhận yêu cầu mới không và đã có nhãn hoàn thành chưa. Cách này phân biệt lỗi hiển thị với tồn đọng xử lý.

Một đồng đội diễn tập nhưng không biết ai được quyền tạm dừng tiếp nhận. Nhóm bổ sung ranh giới phê duyệt và người phụ trách cập nhật khách hàng. Diễn tập chỉ ra thiếu sót tài liệu, không chứng minh một biện pháp sửa chữa luôn thành công.

Kiểm tra khả năng bàn giao, không chỉ câu chữ

Nhờ đồng nghiệp làm theo trong mô phỏng có kiểm soát mà không được hướng dẫn bằng lời. Ghi lại mọi chỗ họ phải đoán. Dùng danh sách này để quyết định tài liệu đã sẵn sàng hay chưa.

Hướng dẫn quá chi tiết tốn công rà soát khi dịch vụ thay đổi. Tài liệu quá rộng lại che mất quyết định cần làm ngay. Hãy để kiến trúc nền trong tài liệu tham chiếu được duy trì riêng, chỉ giữ nội dung người phản ứng sự cố cần trong runbook.

Giao người sở hữu và rà soát sau thay đổi hoặc diễn tập liên quan. Nếu một bước lỗi thời, hãy rút lại hoặc sửa thay vì chỉ nhắc miệng. Phép nghiệm thu là một người khác có thẩm quyền có thể làm theo tài liệu một cách an toàn hay không.

• Nêu triệu chứng đầu vào và một trường hợp loại trừ rõ ràng.
• Chỉ ra điều cần quan sát sau mỗi quyết định.
• Nêu người phê duyệt thay đổi dịch vụ.
• Có điều kiện dừng và người nhận chuyển cấp.
• Xác định ai xác nhận quy trình khách hàng đã phục hồi.