Le guide dont vous avez besoin à trois heures du matin

Source du concept: On-call- Google SRE Workbook. Le format et l'échantillon de la présente note sont un modèle de proposition indépendant pour la documentation opérationnelle.

Un documentaire utile devrait clarifier la décision suivante à un moment où l'attention est trop faible. Pour moi, commencer une page détaillée est mieux qu'un grand dossier avec des commandes anciennes. Bien sûr, une page est le seul point d'entrée; des détails spécialisés peuvent être inclus dans les documents de lien.

Que devrait être la première page?

• Application et importance: Que fait ce service pour l'utilisateur et que fait-il?
• Propriétaire et chemin de référence: Où est la méthode de contact technique, successeur et organisationnel?
• Pièces jointes : Quel est le nom logique des services nécessaires, du lieu et de l'ordre d'examen?
• Santé et preuves : Quels sont les tests d'utilisateur réussis, l'emplacement et les signes d'erreur connus?
• Récupération et retour : Quel est le lien de procédure confirmé, l'emplacement de référence de secours et les conditions d'arrêt des opérations?
• Crédit documentaire : Qui et quelle date a-t-elle adapté à la situation réelle?

Un échantillon hypothétique.

Pour le rapport interne, il peut être écrit: le devoir est un rapport quotidien; l'affiliation essentielle, le rapport de base de données; le test de santé est l'entrée du compte d'essai et l'ouverture du rapport d'échantillon; en cas d'erreur, l'heure de l'événement et le numéro d'identification d'application sont vérifiés, puis le journal d'utilisation. Les vrais noms et itinéraires doivent être complétés par le même environnement.

La valeur de cet échantillon n'est pas dans le nombre de champs; la personne suivante comprend où commencer et quels résultats sont valides. Les commandes telles que "Si elle est cassée, start-up" ne sont pas un guide fiable sans condition, effet secondaire et mesure du succès.

Le documentaire a besoin du test.

Demandez à l'auteur de ne pas suivre un scénario avec le même guide. Partout où il devait poser une question orale, une réelle ambiguïté a probablement été trouvée. Examiner le document après le changement important de service.

Ma suggestion: Ne laissez pas le mot de passe, jeton et clé privée à l'intérieur de la page; mentionnez simplement la méthode d'accès au réservoir de sécurité. Le document doit être trouvé et adapté au niveau d'accès de l'auditoire. Gardez la version publique ou l'échantillon éducatif séparé de l'information réelle du réseau.

Étude connexe: Vérifiez la liste avant le début..