Je suis partenaire d'un contrat de trois personnes / service de conseil depuis juin 2004. Nous travaillons chacun principalement sur nos propres "comptes", mais nous devons maintenir une documentation pour permettre le "basculement" entre les partenaires. La plupart de nos clients ont une sorte de personnel informatique interne, dont beaucoup effectuent une certaine maintenance quotidienne, et nous devons également leur communiquer efficacement la documentation.
Mes deux associés ont l'avantage (si l'on peut appeler cela ainsi) d'avoir travaillé en tant qu'employés auprès de moi dans une autre entreprise et, par conséquent, ils ont tous deux été endoctrinés à ma façon de faire les choses. La stricte cohérence (où les choses peuvent évidemment se trouver) entre les configurations des clients est une aubaine. De toute évidence, les produits changent, nous devons donc discuter de nouveaux produits / versions, etc., et décider d'une stratégie de configuration cohérente avant de déployer. Cela ne serait pas adapté à une grande entreprise mais, franchement, je vois cela comme une fonctionnalité plutôt qu'un bug. (Je ne commencerai pas à me plaindre des grandes entreprises de "services gérés" avec leurs "ingénieurs" employés et des tendances horribles pour les offres ponctuelles, les "solutions" à moitié déterminées et les incohérences entre les clients ...> sourire <)
Je suis violemment contre "le cahier redouté". Je ne l' ai jamais vu des documents sur papier tenue à jour jamais . Je pense que c'est une perte d'argent pour le client de passer du temps à faire des copies physiques de la documentation. Je préfère de loin passer du temps à trouver comment générer de la documentation basée sur des données "en direct" à partir de configurations en cours d'exécution.
À titre d'exemple, je ne conserverai absolument pas les feuilles de calcul des informations d'adresse IP. C'est à cela que servent DHCP et DNS (voir ci-dessous pour les détails). Si ces choses ne fonctionnent pas, nous avons des problèmes majeurs.
Nous avons eu des clients qui demandent des choses comme «créer un document qui montre toute notre configuration de stratégie de groupe» et j'ai creusé mes talons et j'ai refusé de le faire. Ma contre-proposition récurrente (qui a fonctionné jusqu'à présent) a été de présenter au client des outils administratifs qui peuvent lui donner un "libre-service" ou utiliser un logiciel pour générer une documentation conviviale "en direct" à la demande.
Nous nous efforçons vraiment d'être méticuleux pour expliquer les choses en anglais simple. Un contact informatique non technique peut, par exemple, examiner l'appartenance à un groupe Active Directory d'un ordinateur et voir des choses comme «Logiciel - Installer Microsoft Office 2010 Pro» et «Stratégie de groupe - Connexion automatique à l'ordinateur du kiosque d'expédition». Il ne faut aucune documentation pour expliquer ce que ces choses signifient.
Voici quelques données "en direct" que nous utilisons:
Toutes les allocations d'adresses IP sont stockées dans des serveurs DHCP - cela inclut également les appareils à adresse statique (notés comme tels dans les commentaires). Les adresses MAC et IP peuvent être facilement interrogées par des scripts ou manuellement et, par définition, les données doivent être à jour si elles sont utilisées en production.
Tout obtient un nom et un enregistrement PTR dans DNS. La plupart des hôtes obtiennent également un enregistrement HINFO. Les éléments qui nécessitent des descriptions détaillées obtiennent un enregistrement TXT.
Utilisation abondante et détaillée des champs "Notes" dans la mesure du possible - Active Directory, descriptions d'ordinateurs, descriptions de dossiers partagés, etc. Nous sommes également explicites et clairs avec des choses comme les noms des groupes de sécurité.
Commentaires / remarques dans les configurations des équipements réseau (commentaires sur les ACL, descriptions sur les ports, emplacement SNMP / informations de contact, par exemple).
Je suis assez négatif sur l'idée du stockage d'informations de forme libre dans des choses comme les fichiers texte, les wikis, etc. La structure permet une bonne recherche. Chaque fois que je peux faire fonctionner un mécanisme de stockage structuré pour moi (même si cela signifie que je dois écrire un logiciel pour l'interroger), je le préfère. Les commentaires que je peux analyser à partir des fichiers de configuration, des bases de données, etc., me séduisent toujours lorsqu'ils sont confrontés à des documents générés manuellement qui seront obsolètes presque immédiatement.
Lorsque nous devons stocker des informations de "forme libre", nous utilisons notre propre référentiel SVN. Il contient tous les différents éléments de documentation statique que nous avons créés au fil des ans, classés par le client. Nous utilisons SVN pour cela depuis 2004 et cela a très bien fonctionné comme outil de collaboration pour nous. Nous mettons à jour les schémas de base de données, les scripts sysadmin, les sauvegardes d'objets de stratégie de groupe, etc. J'essaie de vérifier tout ce que je peux dans le contrôle de version.
Il est très facile de rechercher ma caisse avec des outils d'indexation basés sur un système de fichiers. Je sais que chacun de nous dispose d'au moins une copie complète du référentiel localement à tout moment. Nous avons également rendu le référentiel accessible via WebDAV authentifié sur SSL au cas où nous devions absolument accéder à des données qui y sont stockées et avoir uniquement accès au navigateur.
On ne nous a jamais demandé de le faire, mais nous serions heureux de créer un compte sur le serveur SVN pour permettre à un client de retirer et d'interagir avec ses propres fichiers (s'il a une ressource interne qui est si encline ). Nous utilisons un format standardisé pour stocker toute la documentation client statique (documentation de licence logicielle, enregistrements d'achat, etc.) qui est assez explicite.
En plus du référentiel SVN, nous auto-hébergeons également notre courrier électronique. Tous les e-mails entrants / sortants ont été archivés depuis que le domaine de l'entreprise a commencé à recevoir des e-mails. Il est disponible sous forme de journaux BSMTP aux partenaires pour référence (et, personnellement, je l'ai trouvé inestimable). La situation ne s'est jamais présentée, mais je sais que nous serions heureux de donner à un client l'accès aux journaux de toute correspondance à / de ses employés s'il le demandait. Fournir une communication interne entre les partenaires serait plus difficile car nous pourrions bien référencer plusieurs clients dans le même message. (Nous devrions probablement être meilleurs à ce sujet, mais nous ne l'avons pas été.)
Les mots de passe sont une «verrue» majeure dans notre processus. Nous utilisons des référentiels "Password Safe" individuels (avec des combinaisons uniques) pour chaque client afin de permettre le partage du fichier sécurisé avec le client. Nous conservons les mots de passe principaux pour tous les fichiers sûrs dans un autre fichier sûr, avec une combinaison connue uniquement des partenaires. Cette partie a vraiment besoin de travail. Je pense que nous aimerions que chaque client héberge un coffre d'informations d'identification sur site à l'aide d'une véritable application de coffre de mots de passe multi-utilisateurs (avec une piste d'audit, etc.), mais nous avons lancé cette idée sur la plage depuis près de 10 ans maintenant .
Nos enregistrements de suivi du temps sont méticuleusement détaillés et fournis aux clients dans le format électronique de leur choix (qui, jusqu'à présent, était du texte ASCII et PDF). Les clients obtiennent des heures de début et de fin pour chaque événement facturable et une description détaillée du travail effectué. Nous considérons que ces notes de service sont très utiles en interne car elles nous permettent de rester informés de ce qui se passe sur les sites clients des partenaires. En cas de problème, ces enregistrements nous donnent une connaissance de tous les problèmes et résolutions antérieurs que nous avons rencontrés au fil des ans. Je n'ai pas honte de dire que j'ai résolu des problèmes pour un client en trouvant des notes que j'avais oublié d'écrire pour un autre client des années auparavant.
Mise à part une mise en garde rapide et mise en garde concernant la production de documents: à mon "ancien emploi" (travaillant pour quelqu'un d'autre il y a des années), la société a intenté une action en justice contre un client non rémunéré. Nous nous sommes retrouvés en fin de compte d'une contre-poursuite du client non payant. Nos dossiers internes et e-mail concernant ce client ont été assignés à comparaître et mis à nu devant le tribunal. Cette expérience m'a beaucoup appris sur le fait de ne rien stocker sur un support fixe que vous ne voulez pas rendre public.
J'avais écrit quelques courriels contenant des mots (ou herm) choix et des phrases sur mes frustrations avec ce client et avec certains des autres "ingénieurs" de mon entreprise. Devoir être contre-interrogé sur ces choses en audience publique n'était pas quelque chose que j'aimais du tout.
Lorsque nous avons démarré notre activité actuelle, les partenaires ont convenu que tous les enregistrements fixes (e-mail, messages texte, messagerie vocale, fichiers dans le référentiel SVN, enregistrements de travail dans le suivi du temps, etc.) seraient considérés comme "face au client" tout le temps - même s'ils n'ont jamais été destinés à se retrouver entre les mains des clients. Cela a été difficile à faire et demande beaucoup de discipline, mais je pense que cela en vaut la peine. Nous voulons certainement projeter un air de professionnalisme à nos clients, et vivre c'est la façon de le faire. Je ne serai certainement jamais gêné comme je l'étais à nouveau dans cette salle d'audience.