Parcourir les catégories
Explorer
Fiverr Pro
Français
$
USD
Je rédigerai des procédures opérationnelles standard, des runbooks et de la documentation de processus
Documentation technique et automatisation des données pour les équipes de développement logiciel
Je suis ingénieur logiciel. J'écris les documents dont les équipes de développement ont besoin et que personne ne veut rédiger : cahiers des charges, références API, manuels utilisateur, runbooks. Et ...
À propos de ce service
À trois heures du matin, personne ne lit une page wiki. Ils suivent des étapes, ou ils improvisent, et improviser est la façon dont un petit incident devient un long incident.
Je suis ingénieur logiciel. J’écris la procédure que la personne de garde peut suivre sans connaître le système.
CE QUE VOUS OBTENEZ
Quand l’exécuter, et quand ne pas l’exécuter
Vérifications préalables : ce qu’il faut confirmer avant de toucher à quoi que ce soit
Étapes numérotées avec les commandes réelles, pas une description de celles-ci
Vérification : comment savoir si cela a fonctionné
Rollback, ou une déclaration honnête qu’il n’y en a pas
Escalade : qui réveiller, et quand
SE DESTINE À
Failovers, restaurations et redémarrages
Déploiements, releases et rollbacks
Intégration et désintégration
Sauvegardes, renouvellements de certificats, maintenance programmée
Tout processus qui aujourd’hui vit dans la tête d’une personne
COMMENT ÇA FONCTIONNE
1. Dites-moi le processus, ou faites-moi le parcourir lors d’un appel
2. Je l’écris, puis je vous le rends en version testable
3. Nous corrigeons les étapes qui se sont avérées ambiguës
Si une étape ne fonctionne que parce que quelqu’un connaît une astuce, cette astuce est intégrée dans le document.
Écrivez-moi aussi en italien.
Préférence du type de livraison
Veuillez informer le freelance de toute préférence ou préoccupation concernant l'utilisation d'outils d'IA dans la réalisation et/ou la livraison de votre commande.
Mon portfolio
FAQ
Traduction automatique
Nous n’avons aucune documentation. Par où commencer ?
Avec la procédure qui serait la plus nuisible si la personne qui la connaît était indisponible. Généralement, il s’agit d’un failover, d’une restauration ou d’un déploiement. Un bon runbook vaut plus que dix pages à moitié écrites.
Avez-vous besoin d'accès à nos systèmes de production ?
Non, et je préférerais ne pas l’avoir. Un appel de walkthrough, une sortie de terminal redigée et vos notes d’architecture suffisent. Vous gardez vos identifiants ; je garde des espaces réservés dans le document pour tout ce qui est spécifique à l’environnement.
Quel format utilisons-nous, et pouvons-nous continuer à l’éditer ?
Markdown, Word, PDF ou HTML prêt pour Confluence, selon ce que votre équipe utilise. La source vous appartient, vous pouvez la versionner dans Git avec le code qu’elle décrit. Je vous fournis aussi le modèle pour que les nouvelles procédures soient cohérentes.
