I cinque errori principali che le aziende fanno riguardo a documentazione tecnica
La ho vista ripetutamente. Una delle debolezze più comuni che ho visto nelle aziende-effettivamente di ingegneria, quasi un universale difetto-è la mancanza di documentazione tecnica adeguata. Alcuni riderebbero questo fuori come particolare secondario; tuttavia, le ripercussioni sono spesso severe. L'intero futuro dell'azienda può essere fatto o perso basato sulla quantità di attenzione che prestano a questa edizione.
Nel corso degli anni, ho identificato cinque problemi che ho trovato per essere particolarmente comune quando viene alla documentazione tecnica di scrittura. Vorrei ripartire questi pensieri con voi, nella speranza di impedire altri la caduta gli stessi percorsi.
1. Non avere qualsiasi manuali di utente
Non rida. Ciò può sembrare come un errore-irragionevole ragionevolmente fondamentale, uniforme-ma è sorprendentemente terreno comunale. Ho incontrato molte aziende che non forniscono i manuali di utente per i loro prodotti, o di cui i manuali sono skeletally sottili o anni antiquati. Infatti, valuterei che circa la metà di piccole aziende di ingegneria che ho incontrato l'entr in questa categoria. (naturalmente, si incontra raramente questo problema quando compra il software o l'elettronica di consumatore disponibile immediatamente. Fra gli assistenti tecnici comunque, è una storia depressingly esperta.)
Mi ricordo di come un assistente tecnico mi ha detto perchè la sua azienda non ha fornito ad alcuni manuali di utente i loro prodotti. Nei toni hushed,egli disse, "è perché non facciamo alcuni soldi scrivendo i manuali. Non è un'impresa del far soldi, in modo da la nostra amministrazione non desidera sprecare il tempo su questa." Un'espressione infastidita ha strisciato nella sua faccia, allora ha appoggiato a più vicino e detto, "abbiamo perso tanti clienti perché non abbiamo documentazione decent. Parli dell'essere penny-saggio, libbra-insensato!"
Non è giusta i clienti che soffrono quando i manuali sono inadeguati o inesistenti. Che cosa circa gli impiegati essi stessi? Che cosa accade quando un nuovo assistente tecnico viene a bordo e deve imparare rapidamente? O che cosa accade quando gli assistenti tecnici attuali devono rendersi familiare di più alle funzioni non pratiche delle loro serie di prodotti? La documentazione dell'utente, se scritta correttamente, può fornire un senso delicato ed efficiente di portare fino a la velocità. Senza esso, saranno costretti per contare più pesante su altri assistenti tecnici per istruirli, così sprecando il periodo di tutto interessato. Le settimane, se non i mesi, di forza di lavoro importante possono essere sperperati in questo modo.
2. Non avere documentazione interna adeguata
Non è giusta la documentazione dell'utente su che le aziende sono a corto. La documentazione interna è frequentemente un incidente pure, poichè le aziende rimescolano per liberare un prodotto. Nella loro rapidità per portare i prodotti al mercato, le aziende lasciano spesso i loro documenti interni di disegno cadere disperatamente dal wayside.
Non aiuta che i programmatori e gli assistenti tecnici sono rinomati per avere abilità di comunicazione del lackluster e che la documentazione è un'operazione che godono raramente. Ho incontrato molte aziende del software, per esempio, di cui i disegni del software erano un mess insolubile dovuto la loro mancanza di documenti architettonici, descrizioni dell'interfaccia ed osservazioni di in-codice. Tristemente, ho visto i problemi simili quando viene ai disegni meccanici, i disegni elettronici, processi di fabbricazione? lo chiamate.
Ho parlato agli assistenti tecnici di cui le aziende sono andato sotto, o sto barcollando sul bordo. Quasi invariabilmente, la mancanza di documentazione sufficiente è stata un fattore importante in tali situazioni.
Dico sempre alle mie sporgenze e colleghe, "desidero assicurarsi che il mio lavoro darned bene ha documentato. Se lascio l'azienda, o se muoio in un incidente di automobile, dato che in io desideri assicurarsi che questa azienda può marciare sopra senza di me." Quello dovrebbe essere uno dei motivi principali dietro mantenere completo documentazione-a si assicura che l'azienda non sarà paralizzata da assenza del chiunque.
Purtroppo, molti impiegati prendono l'aderenza opposta. Scrimp espressamente sulla documentazione, pensante che questa accerti loro un certo lavoro sicurezza-e a volte, questa funzionano. Tuttavia, un datore di lavoro astuto sa che un assistente tecnico che documenta bene vale molto più di un altro assistente tecnico che mantiene le sue schede vicino alla sua maglia. Il posteriore può essere essenziale a breve termine, ma infine, è una responsabilità di lunga durata.
3. Dimenticare i suoi pubblici
Questo problema accade spesso quando sviluppa la documentazione dell'utente. I programmatori e gli assistenti tecnici si dimenticano frequentemente che i loro manuali stanno andando essere letti dalla gente che è non pratica con i loro prodotti, o che non ha le stesse abilità tecniche. Mi ricordo di un'azienda nell'azienda particolare-un del regolatore della macchina sul litorale ad ovest. Il loro "manuale di utente" era un hodge-podge horrible delle sigle, termini non definiti e pensieri apparentemente casuali, con circa le procedure un dozzina elencate in nessun ordine particolare. La loro documentazione dell'utente difettava di tali particolari di base come come iniziare il regolatore in su, o come arrestarlo nel caso dell'particolari emergenza-critici che tutto l'utente del neofita dovrebbe invitare a trovare in un manuale.
Un problema relativo è l'omissione di usare la lingua adeguata. Consideri il caso in cui molti dei lettori non sono inglesi natali altoparlante-dicono, quando vendita un prodotto in Europa o l'Asia, o quando redigono le procedure del complessivo per gli operai di fabbrica foreign-born. In tali casi, può essere necessario da mantenere la lingua ragionevolmente semplice. Se questo non è possibile-dica quando discutono i particolari complessi che richiedono la moltissima precisione-un possono compensare spesso aggiungendo alcuni tabelle, schemi o fotografie adatto-scelti. Il uno o il altro metodo può essere utile nel rendere a testo complesso un poco più facile assorbire.
4. Non essendo adeguatamente grafico
È innegabilmente cliché, ma ciò nonostante-un l'immagine allineare vernicia mille parole. Similmente, un manuale che l'uso giudizioso di marche delle immagini e degli schemi sarà molto più facile da capire che uno che si compone interamente di descrizioni del testo.
Alcuni considerare questo come childish ed inutile. Non e la mia esperienza ha indicato che la maggior parte degli utenti apprezza avere queste guide visive. Ricordisi di; non importa come reso sofisticato i vostri lettori sia, sono ancora essere umano. Anche un intelligente, altrimenti lettore attento può mancare casualmente un certo particolare importante, particolarmente una volta fatto pressione per tempo.
5. Non tentando d'ottenere il merito
È interessante vedere come i programmatori e gli assistenti tecnici possono tentare d'ottenere merito in molte funzioni del loro lavoro, tuttavia prende l'esatto di fronte al metodo quando viene a documentazione. "chi si preoccupa per l'espressione comunque?" Mi sono sentito che molti assistenti tecnici dicono. "non stiamo scrivendo la poesia o gli screenplays qui. Che cosa importa è che la documentazione deve essere tecnicamente esatta."
Ciò è una vista terribile miope. L'esattezza tecnica è effettivamente importante, ma in modo da sono la presentazione e lo stile. Pochi assistenti tecnici ascolterebbero un candidato di lavoro che rivela in bathrobe e pistoni, o un avvocato di controversia che parla come una valle ragazza-e tuttavia in qualche modo, questi stessi assistenti tecnici prevedono i loro techies del collega (o più difettoso, un cliente!) per slog attraverso le pagine di serpeggiare, testo male esprim. Anche importa fondamentale quanto l'ortografia, la grammatica e correggere le bozze sono trattare spesso come i particolari disturbo-annoyances-piddling puri che valgono nient'altro che un'occhiata rapida.
(al mio rilievo, non ho incontrato qualsiasi atteggiamenti alla mia sede di servizio. Accelero dire questo, affinchè non chiunque pensa che stia protestando circa la gente che lavoro con! No, ho trovato che tutti apprezziamo il valore di merito, per cui sono sempre thankful. Ma digress.)
Ricordisi di: Nel scrivere per i suoi techies del collega, si dovrebbe considerare che devono assorbire spesso le quantità di informazioni voluminose nei tempi limitati. Nel scrivere per i laici, uno dovrebbe rendere il testo delicato e facile digerire come possibile, affinchè non sono persi in un oceano di geekspeak. Il uno o il altro senso, mettente un poco sforzo supplementare negli argomenti dell'eleganza e dello stile può fare un mondo della differenza.
Non entrerò nel particolare circa che cosa costituisce la buona tecnica di scrittura, come che sarebbe oltre la portata di questo testo. Basti dire che un buon programmatore o assistente tecnico dovrebbe assicurarsi che la sua scrittura è leggibile e bene-organizzata e che fluisce uniformemente da un soggetto un altro.
Sarei eccitato oltre credenza se non vedessi mai un altro manuale slipshod, o se non sentissi mai un'altra storia circa sprofondare delle aziende dovuto documentazione inesistente. Una fantasia disperata? Forse. Eppure, spero che alcuni techies fuori là leggano questo messaggio e che lo prenderanno a cuore.
Circa L'Autore
V. Berba Velasco ha un doctorate nell'ingegneria elettrica e sta maneggiando il suo commercio per quasi una decade. Durante quel tempo, ha scoperto ripetutamente l'importanza di buona scrittura tecnica ed i trabocchetti che possono accadere dall'ignorare il relativo valore.
Il Dott. Velasco attualmente lavora come Software Engineer maggiore per tecnologia cellulare limitata (http://www.immunospot.com, http://www.elispot-analyzers.de), un'azienda ed elettrotecnica del biotech a Cleveland, Ohio. Durante il suo tempo di ricambio, alza gli uccelli del dodo, sviluppa i cervelli ed i giochi umani con la sua accumulazione dei monopoles magnetici.
Fonte dell'articolo: Messaggiamo.Com
Related:
» Credit Secrets Bible» Cash Making Power Sites
» Home Cash Course
» Automated Cash Formula
Webmaster prendi il Codice Html
Aggiungi questo articolo al tuo sito ora!
Webmaster invia i tuoi Articoli
Nessuna registrazione richiesta. Compila il form e i tuoi articoli sono nella Directory di Messaggiamo.Com
