Consulting: Organiser la documentation site / environnement pour les clients? [fermé]

12

Au fil du temps, j'ai entrepris des travaux de conseil et d'ingénierie contractuelle pour divers clients. Plus récemment, les clients demandent certains types de documentation.

  • Quelles adresses IP statiques puis-je utiliser pour la nouvelle horloge réseau que nous installons?
  • Comment mettre une exclusion dans le filtre Web? Le PDG ne peut plus accéder au site Web de la NRA !!
  • Nous devons arrêter le serveur Linux pour une panne de courant planifiée. Quelle est encore la commande?

Ce sont de petites entreprises et n'ont généralement pas de personnel technique dédié. Au sein d'une même entreprise, Wiki / Confluence / Sharepoint, etc. ont tous un sens en tant que référentiel central pour la documentation et les informations sur l'environnement, mais j'ai du mal à trouver une méthode cohérente pour fournir ces informations à des clients discrets .

Je vise un processus plus portable, sécurisé et élégant qu'une simple feuille de calcul ou le classeur redouté rempli d'informations obsolètes .

  • Adresses IP importantes, étendue DHCP, etc.
  • Diagramme du réseau (si nécessaire).
  • Noms d'utilisateur et mots de passe administratifs et URL de gestion.
  • Clés de licence logicielle.
  • Contrats d'assistance et informations sur la garantie.
  • Contacts et instructions pour l'assistance aux fournisseurs.

Je sais qu'il y a d'autres consultants ici. Avez-vous des suggestions ou des conseils sur la maintenance de la documentation dans plusieurs environnements dans un format convivial? Comment tu fais?

ewwhite
la source

Réponses:

12

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.

Evan Anderson
la source
1
Excellente réponse. Bien que je ne sois pas consultant et ne travaille que pour une seule grande entreprise, je suis d'accord avec la plupart des choses. J'ajouterais qu'une base de données d'actifs qui remplit des choses comme le DNS, la surveillance, la marionnette, etc. peut aussi être une bonne chose, mais ne stockez pas dans celle-ci des informations que vous n'utilisez pas, ou elle sera obsolète et sera inutile.
Dennis Kaarsemaker
Quel type de logiciel utilisez-vous pour générer ces rapports en direct? Qu'en est-il des choses comme les emplacements physiques, les diagrammes de basculement, etc.?
Steve Butler
@SteveButler - Lorsque je serai un peu libéré, je développerai ce que vous demandez ainsi que la modification de la question. Il y a moins de moi pour faire le tour que jamais ...> sourire <
Evan Anderson
2

Pour les informations de base comme vous décrivez (à l'exception d'un diagramme de réseau), nous utilisons un seul classeur Excel et l'enregistrons dans un dossier réseau avec le nom du client. Bien que je puisse comprendre pourquoi les gens n'aiment pas cette approche, je trouve que cela fonctionne très bien car c'est un document de référence unique que je peux emporter avec moi sur le site, envoyer par courrier électronique et mettre à jour rapidement.

Ma plus grande plainte serait le manque de contrôle de version, mais je n'ai encore rien trouvé qui fonctionne bien sans rendre la vie difficile.

Pour contrer votre "Je vis pour un processus plus portable, sûr et élégant qu'une simple feuille de calcul":

Plus Portable: Qu'est - ce que peut être plus portable que 500 kilo - octet feuille de calcul? J'aurais peur d'utiliser quoi que ce soit dans le cloud ou sur le Web, car la connectivité Internet ne peut pas être garantie.

Sécurisé: Celui-ci, je vais vous le donner et je voudrais moi aussi des solutions pour rendre notre solution plus sûre.

Élégant: nous avons passé du temps à créer un joli modèle pour notre classeur. Comme je l'ai dit, il s'agit d'un classeur à plusieurs feuilles, pas seulement d'une énorme page d'informations dispersées. Je pense que la plupart des documentations informatiques s'intègrent bien dans une forme tabulaire et une feuille de calcul garde cela très soigné et simple.

Bien que j'aie beaucoup de problèmes avec la façon dont nous enregistrons et stockons la documentation de construction, je ne trouve vraiment rien à redire dans une feuille de calcul solide et bien formatée. J'ajouterai également que nous travaillons avec de grandes sociétés de services informatiques et qu'elles fonctionnent à peu près de la même manière. Encore une fois, c'est génial - je me présente sur le site, je demande la documentation et j'obtiens une seule feuille de calcul soignée que je peux utiliser pour la durée.

Dan
la source
2

Le gros avantage de ce liant redouté est:

  • Les clients non techniques peuvent le comprendre, le garder sur place et le garder en sécurité comme ils l'ont l'habitude et le font déjà avec toutes sortes d'autres documents importants.
  • Vos clients peuvent facilement le remettre au cas où ils embaucheraient un remplaçant pour vous, une chose professionnelle à faire et quelque chose qui vous aurait donné un démarrage rapide et une référence lorsque vous les avez atterris en tant que clients.
  • Un simple journal de maintenance au début avec les points forts de chaque visite du site est quelque chose de tangible.
  • Le classeur contient également des CD / DVD et des certificats avec des codes de licence et des clés d'activation en cas de visite du BSA ou d'un autre fournisseur.

Quel que soit le système numérique que vous utilisez, cela n'a plus vraiment d'importance tant que vous vous disciplinez pour mettre à jour le classeur chaque fois que vous avez fait quelque chose de valable.

Et le classeur vous est bien sûr complètement inutile si vous faites presque tout votre support à distance.

J'ai été un grand fan de l'utilisation d'un wiki car il est facile à entretenir, les hyperliens vers les interfaces de gestion et de BIT, le bureau à distance et les connexions SSH sont facilement suivis. La forme libre convient à la plupart des informations que je souhaiterais avoir:

  • description du site: "l'imprimante réseau (OKI 1234 MFP) est celle à côté du bureau de John, l'imprimante à jet d'encre HP modèle 0123 se trouve à Bobs, le bureau du patron", il est beaucoup plus facile de répondre à un appel téléphonique: "nous avons à court d'encre, quelle cartouche faut-il commander à nouveau? ".

  • page pour chaque appareil, idéalement avec une image, le type et la configuration, son but, etc.

  • Il existe des modules d'exportation décents pour les Wiki afin de générer des documents papier ou numériques à remettre et à inclure dans ce classeur redouté

HBruijn
la source
Bons points. Je suis éloigné de 90% de mes clients, mais je voyage souvent. Souhaitez-vous suggérer un wiki central que j'héberge par rapport à quelque chose sur place?
ewwhite
Lorsque vous hébergez le wiki, il devient beaucoup plus facile de le configurer pour qu'il se synchronise avec votre ordinateur portable, ce qui semble prudent lorsque vous voyagez souvent.
HBruijn
0

Je suis d'accord avec Dan sur Excel étant une bonne solution portable et je pense qu'il en fait un excellent argument, sauf pour la partie sécurité où je pense que les inquiétudes sont quelque peu mal orientées:

Quelle que soit la méthode avec laquelle vous souhaitez distribuer, une solution sécurisée pourrait être couverte (par exemple, courrier électronique crypté, stockage partagé sécurisé, etc.). Il en va de même pour le contrôle de version (par exemple les clichés instantanés, svn, etc.).

Cependant, juste à titre de critique constructive et avec tout le respect, j'ajouterais qu'un inconvénient majeur avec une feuille de calcul Excel partagée est ses limitations de concurrence. Le jour où vous avez deux administrateurs ou plus, ils trouveront une peine royale d'être obligé de choisir entre un seul à la fois pour pouvoir ouvrir la feuille pour modification, ou pour avoir plusieurs copies enregistrées qui doivent ensuite être fusionnées (quelles données sont à jour et lequel ne l'est pas?). Et c'est vraiment une douleur.

Une meilleure solution consiste à utiliser Excel (ou tout ce que vous souhaitez) comme interface avec une petite base de données de votre choix, que ce soit Access (juste pour aborder la portabilité), MS SQL, MariaDB ou tout ce qui vous convient.

Je préconise cela comme une solution qui n'est pas seulement adaptée pour transmettre des informations à une autre partie (= Excel) mais qui convient également pour maintenir un effort de documentation continue.

Mon avis en bref est que, même avec quelques administrateurs (sans parler des plus grands magasins), un département qui s'appuie sur Excel pour le stockage des données de documentation est un département avec une documentation tentaculaire. Jamais vu d'exception à moins qu'il n'y ait qu'un seul administrateur.

Mais un département utilisant le stockage basé sur une base de données a la possibilité de conserver une documentation serrée et à jour. Ce n'est alors qu'une question d'effort. Un Excel est un front-end fonctionnel avec des avantages et des inconvénients, mais en aucun cas la seule option.

ErikE
la source
Rappelons qu'il s'agit d'une situation de conseil, avec plusieurs clients. Il n'y aura aucun problème de concurrence.
ewwhite
0

Ce n'est peut-être pas tout à fait ce que vous recherchez, mais voici ce que je fais.

J'utilise Microsoft Office pour créer tous les documents pour chacun de mes clients. J'utilise Excel (informations d'adresse IP, mappage de port de commutateur, disposition du rack), Word (informations de configuration, factures, modèles SOW) et Visio (diagrammes). Je crée une hiérarchie de dossiers avec le dossier parent nommé Consulting et un dossier enfant nommé pour chaque client. Lorsque je crée ou mets à jour des documents clients, je les synchronise avec mon iPhone (à l'aide de Documents To Go ), une clé USB et un compte DropBox (à l'aide de l'authentification à deux facteurs). De cette façon, j'ai accès à toute la documentation (d'une manière ou d'une autre) partout et partout où je vais.

J'utilise également une application de gestion de projet / reporting / facturation / suivi du temps appelée OfficeTime . Il y a une application iPhone et une application Windows associée, j'ai donc accès aux informations du projet, à la facturation, aux heures, etc. sur mon iPhone lorsque je suis sur place et à la synchronisation avec mon bureau lorsque je rentre à la maison.

joeqwerty
la source
0

Bien que ce ne soit pas une solution parfaite, mais vous devriez jeter un œil à Device42 .

Voici ce que vous pouvez faire: les IP et les périphériques peuvent être associés aux clients. Et vous pouvez avoir des groupes VRF pour les plages IP qui se chevauchent chez différents clients.

Il n'a pas d'autorisation granulaire pour les IP / appareils (juste un accès basé sur un rôle global), vous ne pouvez donc pas autoriser l'accès direct aux clients finaux. Mais vous pouvez créer des rapports par client avec des informations sur l'appareil et l'adresse IP et les envoyer au client final chaque fois que nécessaire.

Cela vous donnera au moins une interface pour organiser toutes les informations dans un référentiel central. Vous pouvez stocker les informations sur les actifs, les informations IP, les informations sur les contrats et les mots de passe.

En outre, il fournit la plupart des informations sur les appels d'API REST, mais vous ne savez pas si vous pouvez câbler quelque chose pour des clients individuels en fonction de cela.

Sonu Bansal
la source
Ce n'est pas tout à fait approprié, mais une plateforme de gestion d'actifs intéressante pour les environnements plus vastes.
ewwhite
1
D'accord, pas un ajustement parfait en fonction de vos besoins. Je leur ai fait une demande de fonctionnalité pour ajouter également un accès basé sur les rôles en fonction des clients. Cela fonctionne bien pour nous, fournisseurs de services cloud, de garder une trace de tous les équipements et adresses IP des clients, mais nous aimerons également donner un accès au portail aux clients afin qu'ils puissent accéder eux-mêmes à leurs informations.
Sonu Bansal