Consulenza: organizzazione della documentazione del sito / ambiente per i clienti? [chiuso]


12

Nel corso del tempo, ho svolto attività di consulenza e ingegneria contrattuale per vari clienti. Più recentemente, i clienti richiedono determinati tipi di documentazione.

  • Quali indirizzi IP statici posso usare per il nuovo orologio di rete che stiamo installando?
  • Come inserisco un'esclusione nel filtro Web? Il CEO non può più accedere al sito Web dell'NRA !!
  • Dobbiamo spegnere il server Linux per un'interruzione di corrente pianificata. Qual è il comando di nuovo?

Queste sono piccole imprese e in genere non dispongono di personale tecnico dedicato. All'interno di una singola azienda, Wiki / Confluence / Sharepoint, ecc. Hanno tutti un senso come archivio centrale per la documentazione e le informazioni sull'ambiente, ma faccio fatica a trovare un metodo coerente per fornire queste informazioni a clienti discreti .

Sto cercando un processo più portatile, sicuro ed elegante di un semplice foglio di calcolo o del temuto raccoglitore pieno di informazioni obsolete .

  • Indirizzi IP importanti, ambito DHCP, ecc.
  • Schema di rete (se necessario).
  • Nomi utente e password amministrativi e URL di gestione.
  • Chiavi di licenza del software.
  • Contratti di supporto e informazioni sulla garanzia.
  • Contatti e istruzioni di supporto del fornitore.

So che ci sono altri consulenti qui. Qualche suggerimento o suggerimento su come conservare la documentazione su più ambienti in un formato a misura di cliente? Come lo fai?

Risposte:


12

Sono partner di un servizio di consulenza / consulenza per tre persone dal giugno 2004. Ognuno di noi lavora principalmente con i propri "account", tuttavia è necessario mantenere reciprocamente la documentazione per consentire il "failover" tra i partner. La maggior parte dei nostri clienti ha una sorta di personale IT interno, molti dei quali eseguono una certa quantità di manutenzione quotidiana e dobbiamo anche comunicare loro la documentazione in modo efficace.

I miei due partner hanno il vantaggio (se puoi chiamarlo così) di aver lavorato come dipendenti sotto di me in un'altra azienda e, di conseguenza, sono stati entrambi indottrinati al mio modo supponente di fare le cose. La rigorosa coerenza (dove ovviamente possono esserci le cose) tra le configurazioni dei Clienti è una manna dal cielo. Ovviamente, i prodotti cambiano, quindi ci impegniamo a discutere di nuovi prodotti / versioni, ecc., E decidere una strategia di configurazione coerente prima di implementarli. Questo non si ridimensionerebbe a una grande azienda ma, francamente, lo vedo come una caratteristica piuttosto che un bug. (Non inizierò a lamentarmi di società più grandi di "servizi gestiti" con i loro "ingegneri" dei dipendenti e di tendenze orribili per le soluzioni una tantum, le "soluzioni" a metà e l'incoerenza tra i clienti ...> smile <)

Sono violentemente contro "il temibile raccoglitore". Non ho mai visto la documentazione fisica sempre aggiornata . Penso che sia spreco di denaro del cliente impiegare del tempo a fare copie fisiche della documentazione. Preferirei di gran lunga dedicare del tempo a capire come generare documentazione basata su dati "live" dalle configurazioni in esecuzione.

Per fare un esempio, io assolutamente voglio non mantenere i fogli di calcolo di informazioni sugli indirizzi IP. Ecco a cosa servono DHCP e DNS (vedi sotto per i dettagli). Se quelle cose non funzionano, abbiamo grossi problemi.

Abbiamo avuto clienti che richiedono cose come "fare un documento che mostri tutta la nostra configurazione di criteri di gruppo" e ho scavato e mi sono rifiutato di farlo. La mia controproposta ricorrente (che finora ha funzionato) è stata quella di presentare al Cliente strumenti amministrativi in ​​grado di fornire loro "self-service" o utilizzare software per generare "live" documentazione a misura di cliente su richiesta.

Facciamo del nostro meglio per essere meticolosi nell'elaborare le cose in un inglese semplice. Un contatto IT non tecnico può, ad esempio, esaminare l'appartenenza al gruppo di Active Directory di un computer e vedere cose come "Software - Installa Microsoft Office 2010 Pro" e "Criteri di gruppo - Accesso automatico al computer del chiosco di spedizione". Non serve documentazione per spiegare cosa significano queste cose.

Ecco alcuni dati "attivi" che utilizziamo:

  • Tutta l' allocazione dell'indirizzo IP è memorizzata nei server DHCP, compresi anche i dispositivi indirizzati staticamente (indicati come tali nei commenti). Gli indirizzi MAC e IP possono essere facilmente interrogati da script o manualmente e, per definizione, i dati devono essere aggiornati se vengono utilizzati in produzione.

  • Tutto ottiene un nome e un record PTR in DNS. La maggior parte degli host ottiene anche un record HINFO. Le cose che necessitano di descrizioni dettagliate ottengono un record TXT.

  • Uso copioso e dettagliato dei campi "Note" ovunque possibile - Active Directory, descrizioni di computer, descrizioni di cartelle condivise, ecc. Siamo anche prolissi e chiari con cose come i nomi dei gruppi di sicurezza.

  • Commenti / osservazioni nelle configurazioni degli ingranaggi di rete (commenti su ACL, descrizioni su porte, posizione SNMP / informazioni di contatto, ad esempio).

Sono abbastanza negativo sull'idea di archiviare informazioni in formato libero in cose come file di testo, wiki, ecc. La struttura consente una buona ricerca. Ogni volta che riesco a far funzionare un meccanismo di archiviazione strutturato (anche se ciò significa che devo scrivere un software per interrogarlo) lo preferisco. I commenti che posso analizzare dai file di configurazione, dai database, ecc., Mi convincono sempre quando vengono confrontati con documenti generati manualmente che non saranno aggiornati quasi immediatamente.

Quando dobbiamo archiviare informazioni "in formato libero" utilizziamo il nostro repository SVN. Contiene tutti i vari pezzi di documentazione statica che abbiamo creato nel corso degli anni, archiviati dal Cliente. Usiamo SVN per questo dal 2004 e ha funzionato molto bene come strumento di collaborazione per noi. Abbiamo schemi di database di versioni, script sysadmin, backup di oggetti Criteri di gruppo, ecc. Cerco di controllare tutto ciò che posso nel controllo delle versioni.

È molto facile cercare nel mio checkout con strumenti di indicizzazione basati su filesystem. So che ognuno di noi ha almeno una copia completa del repository disponibile a livello locale in qualsiasi momento. Abbiamo anche reso accessibile il repository tramite WebDAV autenticato su SSL nel caso in cui dovessimo assolutamente accedere ai dati memorizzati lì e avere solo l'accesso al browser.

Non ci è mai stato chiesto di farlo, ma saremmo felici di creare un account sul server SVN per consentire a un cliente di effettuare il check-out e interagire con i propri file (se hanno una risorsa interna che è così incline ). Utilizziamo un formato standardizzato per l'archiviazione di tutta la documentazione statica del cliente (documentazione sulla licenza del software, registri degli acquisti, ecc.) Che si spiega da sé.

Insieme al repository SVN, ospitiamo anche la nostra e-mail. Tutta l'e-mail in entrata / in uscita è stata archiviata da quando il dominio dell'azienda ha iniziato a ricevere e-mail. È disponibile come log BSMTP per i partner come riferimento (e, personalmente, l'ho trovato prezioso). La situazione non si è mai presentata ma, so che saremmo felici di dare a un cliente l'accesso ai registri di qualsiasi corrispondenza da / verso i suoi dipendenti se mai lo avessero chiesto. Fornire comunicazione interna tra i partner sarebbe più difficile perché potremmo fare riferimento a più clienti nello stesso messaggio. (Probabilmente dovremmo essere migliori al riguardo, ma non lo siamo stati.)

Le password sono una "verruca" importante nel nostro processo. Stiamo utilizzando singoli repository "Password Safe" (con combinazioni uniche) per ciascun cliente per consentire la condivisione del file sicuro con il cliente. Conserviamo le password principali per tutti i file sicuri in un altro file sicuro, con una combinazione nota solo ai partner. Questa parte ha davvero bisogno di un po 'di lavoro. Penso che vorremmo che ogni cliente ospitasse un deposito credenziale in loco utilizzando una vera e propria applicazione di deposito password multiutente (con una pista di controllo, ecc.) Ma abbiamo buttato giù quell'idea da quasi 10 anni .

I nostri registri dei tempi sono meticolosamente dettagliati e forniti ai Clienti in qualunque formato elettronico desiderino (che, fino a questo punto, sono stati testo e PDF ASCII). I clienti ottengono orari di inizio / fine per ogni evento fatturabile e una descrizione dettagliata del lavoro svolto. Consideriamo queste note di servizio molto preziose internamente perché ci consentono di rimanere aggiornati su ciò che accade nei siti dei clienti dei partner. In caso di problemi, questi registri ci forniscono una conoscenza basata su tutti i problemi e le risoluzioni precedenti che abbiamo riscontrato negli anni. Non mi vergogno di dire che ho risolto i problemi per un cliente trovando note che avevo dimenticato di scrivere per un altro cliente anni prima.


A parte un rapido e cautelativo riguardo alla produzione di documentazione: al mio "vecchio lavoro" (lavoro per qualcun altro anni fa) la società ha intrapreso un'azione legale contro un cliente non pagante. Abbiamo finito per essere sul lato commerciale di una controproposta da parte del cliente non pagante. I nostri registri interni e le e-mail relative: che il Cliente è stato citato in giudizio e messo a nudo dinanzi al tribunale. Quell'esperienza mi ha insegnato molto sul non archiviare nulla su un supporto fisso che non vuoi essere reso pubblico.

Avevo scritto alcune e-mail con alcune (erm) parole e frasi scelte in merito alle mie frustrazioni con questo cliente e con alcuni degli altri "ingegneri" della mia azienda. Dover essere stato oggetto di un esame incrociato di queste cose in campo aperto non è stato per niente divertente.

Quando abbiamo iniziato la nostra attività attuale, i partner hanno concordato che tutti i record fissi (e-mail, messaggi di testo, posta vocale, file nel repository SVN, record di lavoro nel time tracker, ecc.) Sarebbero stati sempre considerati "rivolti al cliente", anche se non erano destinati a finire nelle mani dei clienti. Questo è stato difficile da fare e richiede molta disciplina, ma penso che ne valga la pena. Vogliamo sicuramente proiettare un'aria di professionalità ai nostri clienti, e viverla è il modo di farlo. Certamente non sarò mai imbarazzato come se fossi di nuovo in quell'aula di tribunale.


1
Risposta eccellente. Anche se non sono un consulente e lavoro per una sola grande azienda, sono d'accordo con la maggior parte delle cose. Aggiungerei che un database di risorse che popola cose come DNS, monitoraggio, pupazzo, ecc. Può essere una buona cosa, ma non archiviare in esso informazioni che non si usano, o diventeranno obsolete ed inutili.
Dennis Kaarsemaker,

Che tipo di software usi per generare quei report live? Che dire cose come posizioni fisiche, diagrammi di failover, ecc.?
Steve Butler,

@SteveButler - Quando mi libererò un po ', espanderò ciò che mi stai chiedendo e indirizzerò la modifica alla domanda. C'è meno di me in giro che mai ...> sorride <
Evan Anderson,

2

Per informazioni di base come quelle che stai descrivendo (ad eccezione di un diagramma di rete) utilizziamo una singola cartella di lavoro di Excel e la salviamo in una cartella di rete con il nome del cliente. Sebbene io possa capire perché alle persone questo approccio non piace, trovo che funzioni alla grande perché è un unico documento di riferimento che posso portare con me al sito, inviare e-mail e aggiornare rapidamente.

La mia più grande lamentela sarebbe la mancanza di controllo della versione, ma devo ancora trovare qualcosa che funzioni bene senza rendere la vita un duro lavoro.

Per contrastare "Sto girando per un processo più portatile, sicuro ed elegante di un semplice foglio di calcolo":

Più portatile: cosa può esserci di più portatile di un foglio di calcolo da 500 Kilobyte? Avrei paura di usare qualsiasi cloud o webbased perché la connettività Internet non può essere garantita.

Sicuro: questo ti darò e anche io vorrei soluzioni per rendere la nostra soluzione più sicura.

Elegante: abbiamo impiegato molto tempo a creare un bel modello per la nostra cartella di lavoro. Come ho detto, questa è una cartella di lavoro multi-foglio, non solo un'enorme pagina di informazioni sparse. Penso che la maggior parte della documentazione IT si adatti perfettamente a un modulo tabulare e un foglio di calcolo lo mantiene molto pulito e semplice.

Anche se ho molti problemi con il modo in cui registriamo e archiviamo la documentazione di build, non riesco davvero a trovare difetti in un foglio di calcolo solido e ben formato. Aggiungerò anche che lavoriamo con alcune grandi aziende di servizi IT e lavorano allo stesso modo. Ancora una volta, è geniale: mi rivolgo al sito, richiedo la documentazione e ottengo un singolo foglio di calcolo pulito che posso usare per tutta la durata.


2

Il grande vantaggio di quel temibile raccoglitore è:

  • I clienti non tecnici possono capirlo, tenerlo sul posto e tenerlo al sicuro come sono abituati e già fanno con tutti i tipi di altri documenti importanti.
  • I tuoi clienti possono facilmente consegnarlo nel caso in cui assumano un sostituto per te, una cosa professionale da fare e qualcosa che ti avrebbe dato un rapido avvio e un riferimento quando li hai atterrati come clienti.
  • Un semplice registro di manutenzione all'inizio con i punti salienti di ogni visita al sito è qualcosa di tangibile.
  • Il raccoglitore detiene anche CD / DVD e certificati con codici di licenza e chiavi di attivazione nel caso in cui il BSA o un altro fornitore visitino.

Qualunque sia il sistema digitale che usi, non ha più importanza finché ti disciplina per aggiornare il raccoglitore ogni volta che hai fatto qualcosa di utile.

E il raccoglitore è ovviamente completamente inutile per te se fai quasi tutto il tuo supporto da remoto.

Sono stato un grande fan dell'utilizzo di un wiki perché è facilmente gestibile, i collegamenti ipertestuali a ILO e interfacce di gestione, desktop remoto e accessi SSH sono facilmente seguiti. Il formato libero si adatta alla maggior parte delle informazioni che vorrei avere:

  • descrizione del sito: "la stampante di rete (OKI 1234 MFP) è quella accanto alla scrivania di John, la stampante a getto d'inchiostro HP modello 0123 si trova a Bobs, l'ufficio del capo" rende molto più facile rispondere a una telefonata: "abbiamo a corto di inchiostro, quale cartuccia dovremmo riordinare? ".

  • pagina per ogni dispositivo, idealmente con un'immagine, il tipo e la configurazione, il suo scopo ecc.

  • Ci sono alcuni moduli di esportazione decenti per Wiki per generare documenti cartacei o digitali per la consegna e l'inclusione in quel temibile raccoglitore


Punti buoni. Sono distante dal 90% dei miei clienti, ma viaggio spesso. Consiglieresti un wiki centrale che ospito rispetto a qualcosa di locale?
ewwhite,

Quando si ospita il wiki diventa molto più semplice configurarlo per la sincronizzazione con il laptop, il che sembrerebbe prudente quando si viaggia spesso.
HBruijn,

0

Sono d'accordo con Dan sul fatto che Excel sia una buona soluzione portatile e penso che sia un ottimo caso, tranne per la parte di sicurezza in cui penso che le preoccupazioni siano in qualche modo mal dirette:

Qualunque sia il metodo con cui si desidera distribuire, una soluzione sicura potrebbe essere coperta (ad esempio e-mail crittografata, archiviazione condivisa protetta ecc.). Lo stesso vale per il controllo della versione (ad esempio copie shadow, svn ecc.).

Tuttavia, solo per mezzo di critiche costruttive e con tutto il rispetto aggiungerei che un grande svantaggio con un foglio di calcolo Excel condiviso sono i suoi limiti di concorrenza. Il giorno in cui hai due o più amministratori, troveranno un dolore reale essere costretti a scegliere tra uno solo alla volta poter aprire il foglio per la modifica o avere più copie salvate che devono quindi essere unite (quali dati sono aggiornato e quale non lo è?). Ed è davvero un dolore.

Una soluzione migliore è usare Excel (o qualunque cosa tu voglia) come frontend per un piccolo database di tua scelta, che si tratti di Access (solo per indirizzare la portabilità), MS SQL, MariaDB o qualsiasi altra cosa ti piaccia.

Sostengo questo come una soluzione che non è adatta solo a trasferire informazioni a un'altra parte (= Excel) ma che è anche adatta a mantenere uno sforzo di documentazione in corso.

La mia opinione in breve è che anche con pochi amministratori (per non parlare dei negozi più grandi), un dipartimento che si basa su Excel per l'archiviazione dei dati della documentazione è un reparto con una documentazione tentacolare. Non ho ancora visto un'eccezione a meno che non ci sia un solo amministratore.

Ma un reparto che utilizza l'archiviazione basata su database ha l'opportunità di tenere una documentazione aggiornata e aggiornata. È quindi solo una questione di sforzo. Un Excel è un front-end db praticabile con pro e contro, ma non è assolutamente l'unica opzione.


Ricordiamo che questo è per una situazione di consulenza, con più clienti. Non ci saranno problemi di concorrenza.
ewwhite,

0

Questo potrebbe non essere proprio quello che stai cercando, ma ecco cosa faccio.

Uso Microsoft Office per creare tutti i documenti per ciascuno dei miei clienti. Uso Excel (informazioni sull'indirizzo IP, mappatura delle porte degli switch, layout del rack), Word (informazioni sulla configurazione, fatture, modelli SOW) e Visio (diagrammi). Creo una gerarchia di cartelle con la cartella principale denominata Consulting e una cartella figlio denominata per ciascun client. Mentre creo o aggiorno i documenti client, li sincronizzo sul mio iPhone (usando Documents To Go ), chiavetta USB e account DropBox (usando l'autenticazione a due fattori). In questo modo ho accesso a tutta la documentazione (in un modo o nell'altro) ovunque e ovunque io vada.

Uso anche un'app di gestione del progetto / reportistica / fatturazione / monitoraggio del tempo denominata OfficeTime . C'è un'app per iPhone e un'app per Windows associata, quindi ho accesso alle informazioni sul progetto, alla fatturazione, alle ore, ecc. Sul mio iPhone quando sono sul posto e mi sincronizzo con il desktop quando torno a casa.


0

Anche se questa non è una soluzione perfetta, ma dovresti dare un'occhiata a Device42 .

Ecco cosa puoi fare: IP e dispositivi possono essere associati ai clienti. E puoi avere gruppi VRF per la sovrapposizione di intervalli IP tra vari clienti.

Non dispone di autorizzazioni granulari per IP / dispositivi (solo accesso basato sul ruolo globale), quindi non è possibile consentire l'accesso diretto ai clienti finali. Tuttavia, è possibile creare report per clienti con informazioni su dispositivo e IP e inviarli al cliente finale ogni volta che è necessario.

Questo almeno ti darà un'interfaccia per organizzare tutte le informazioni in un repository centrale. È possibile memorizzare informazioni sugli asset, informazioni IP, informazioni sul contratto e password.

Inoltre fornisce la maggior parte delle informazioni nelle chiamate API REST, ma non sono sicuro di poter collegare qualcosa per singoli clienti in base a quello.


Non è del tutto adatto, ma un'interessante piattaforma di gestione patrimoniale per ambienti più grandi.
ewwhite,

1
D'accordo, non si adatta perfettamente in base alle tue esigenze. Ho inserito una richiesta di funzionalità per aggiungere un accesso basato sui ruoli basato anche sui clienti. Funziona bene per noi fornitori di servizi cloud per tenere traccia di tutte le attrezzature dei clienti e degli indirizzi IP, ma ci piacerebbe anche dare accesso al portale ai clienti in modo che possano accedere alle loro informazioni da soli.
Sonu Bansal,
Utilizzando il nostro sito, riconosci di aver letto e compreso le nostre Informativa sui cookie e Informativa sulla privacy.
Licensed under cc by-sa 3.0 with attribution required.