Os cinco erros superiores que as companhias fazem no que diz respeito à documentação técnica
Eu vi-a cronometrar e outra vez. Uma das fraquezas as mais comuns que eu vi em companhias-certamente da engenharia, um quase universal falha-está a falta da documentação técnica apropriada. Alguns ririam este fora como um detalhe menor; entretanto, os repercussions são frequentemente severos. O futuro inteiro de uma companhia pode ser feito ou perdido baseado na quantidade de atenção que pagam a esta edição.
Sobre os anos, eu identifiquei cinco problemas que eu encontrei para ser particularmente comum quando vem à documentação técnica da escrita. Eu gostaria de compartilhar destes pensamentos com você, na esperança de impedir que outros caiam abaixo os mesmos trajetos.
1. Não tendo alguns manuais de usuário
Não ria. Isto pode parecer como um erro-mistake-absurd razoavelmente básico, uniforme-mas é surprisingly terra comum. Eu encontrei muitas companhias que não fornecem manuais de usuário para seus produtos, ou os cujos os manuais são skeletally finos ou anos fora da data. No fato, eu estimaria que sobre a metade das companhias pequenas da engenharia que eu encontrei a queda nesta categoria. (naturalmente, se encontra raramente este problema ao comprar o software ou a eletrônica de consumidor off-the-shelf. Amongst coordenadores though, é uma história depressingly familiar.)
Eu recordo como um coordenador me disse porque sua companhia não forneceu nenhuns manuais de usuário com seus produtos. Em tons hushed,disse ele, "está porque nós não fazemos nenhum dinheiro escrevendo manuais. Não é um risco da aquisição de dinheiro, assim que nossa gerência não quer desperdiçar o tempo nesta." Uma expressão irritada rastejou em sua cara, então inclinou mais próximo e dito, "nós perdemos assim muitos clientes porque nós não temos a documentação decent. Conversa sobre ser moeda de um centavo-sábia, libra-pound-foolish!"
Não é justa os clientes que sofrem quando os manuais são inadequados ou inexistentes. Que sobre os empregados eles mesmos? Que acontece quando um coordenador novo vem na placa, e tem que aprender rapidamente? Ou que acontece quando os coordenadores existentes necessitam se familiarizar mais com os aspectos estranhos de suas linhas de produto? A documentação do usuário, se escrita corretamente, pode fornecer uma maneira delicada e eficiente de trazer até a velocidade. Sem ela, serão forçados para confiar mais pesadamente em outros coordenadores para educá-los, assim desperdiçando a época de todos concernido. As semanas, if.not os meses, do manpower valioso podem squandered nesta forma.
2. Não tendo a documentação interna apropriada
Não é justa a documentação do usuário que short da queda das companhias sobre. A documentação interna é freqüentemente uma víctima também, porque as companhias scramble para liberar um produto. Em seu haste para trazer produtos ao mercado, as companhias deixam frequentemente seus originais internos do projeto cair impossìvel pelo wayside.
Não ajuda que os programadores e os coordenadores são notorious para ter habilidades de uma comunicação do lackluster, e que a documentação é uma tarefa que aprecíem raramente. Eu encontrei muitas companhias do software, para o exemplo, cujos os projetos do software eram um mess intractable devido a sua falta de originais architectural, descrições da relação e comentários do em-código. Sadly, eu vi problemas similares quando vem aos projetos mecânicos, projetos eletrônicos, procedimentos de manufacturing? você nomeia-o.
Eu falei aos coordenadores cujas as companhias foram abaixo, ou teetering no brink. Quase invariàvel, a falta da documentação adequada foi um fator principal em tais situações.
Eu digo sempre minhas saliências e colegas de trabalho, "eu quero certificar-se de que meu trabalho darned bem documentou. Se eu deixar a companhia, ou se eu morrer em um acidente de carro, porque no mim queira certificar-se de que esta companhia pode marchar sobre sem mim." Aquela deve ser uma das razões principais atrás de manter-se completo documentação-a certifica-se de que a companhia não estará aleijada por nenhuma ausência de pessoa.
Infelizmente, muitos empregados fazem exame da aderência oposta. Scrimp propositadamente na documentação, pensando de que esta lhes assegurará algum trabalho segurança-e às vezes, esta trabalham. Entretanto, um empregador esperto sabe que um coordenador que documente bem vale a pena distante mais do que um outro coordenador que mantenha seus cartões perto de sua veste. O último pode ser essencial no termo curto, mas finalmente, é uma responsabilidade a longo prazo.
3. Esquecendo-se de one's audiências
Este problema ocorre frequentemente ao desenvolver a documentação do usuário. Os programadores e os coordenadores esquecem-se freqüentemente de que seus manuais estão indo ser lidos pelos povos que são estranhos com seus produtos, ou que não têm as mesmas habilidades técnicas. Eu recordo uma companhia na companhia particular-um do controlador da máquina na costa ocidental. Seu de "manual usuário" era um hodge-podge horrible dos acrônimos, termos undefined e pensamentos seemingly aleatórios, com aproximadamente os procedimentos uma dúzia alistados em nenhuma ordem particular. Sua documentação do usuário faltou detalhes básicos como como começar acima o controlador, ou como pará-lo no exemplo do os detalhes emergência-críticos que todo o usuário do neophyte deve esperar encontrar em um manual.
Um problema relacionado é a falha usar a língua apropriada. Considere o caso em que muitos dos leitores não são ingleses nativos altofalante-dizem, quando marketing um produto em Europa ou Ásia, ou ao escrever procedimentos do conjunto para trabalhadores de fábrica foreign-born. Nesses casos, pode ser necessário manter a língua razoavelmente simples. Se isto não for possível-diga, ao discutir os detalhes complexos que exigem a precisão-um muita podem frequentemente compensar adicionando algumas cartas, diagramas ou fotografias aptly-escolhidas. Uma ou outra aproximação pode ser útil em fazer texto complexo um bocado mais fácil de absorver.
4. Não sendo apropriadamente gráfico
É undeniably cliché, mas nonetheless-a-um o retrato verdadeiro pinta mil palavras. Similarmente, um manual que o uso judicious dos makes das imagens e dos diagramas seja muito mais fácil de compreender do que um que é composto inteiramente de descrições do texto.
Alguns consideram este ser childish e desnecessário. Eu não , e minha experiência mostrou que a maioria dos usuários aprecia ter estas guias visuais. Recorde; não importa como sofisticado seus leitores seja, são ainda ser humano. Mesmo um inteligente, se não leitor cuidadoso pode acidentalmente faltar algum detalhe importante, especial quando pressionado por o tempo.
5. Não striving para o excellence
É interessante ver como os programadores e os coordenadores podem strive para o excellence em muitos aspectos de seu trabalho, contudo faz exame do exato oposto à aproximação quando vem à documentação. "quem se importa com exprimir de qualquer maneira?" Eu ouvi-me que muitos coordenadores dizem. "nós não estamos escrevendo a poesia ou os screenplays aqui. O que importa é que a documentação deve ser tècnica exata."
Esta é uma vista appallingly short-sighted. A exatidão técnica é certamente importante, mas assim que são a apresentação e o estilo. Poucos coordenadores escutariam um pretendente do trabalho que mostrasse acima em um bathrobe e em deslizadores, ou um advogado do litigation que falasse como um vale menina-e contudo de algum modo, este mesmos coordenadores esperam seus techies do companheiro (ou mais mau, um cliente!) para slog através das páginas de meandering, texto mal fraseado. Importa mesmo tão fundamental quanto a soletração, a gramática e corrigir são tratadas frequentemente como os meros detalhes annoyances-annoyances-piddling que não valem a pena nada mais do que um glance cursory.
(a meu relevo, eu não encontrei umas atitudes em meu lugar de emprego. Eu hasten dizer este, a fim de que não qualquer um pense de que eu me estou queixando sobre os povos que eu trabalho com! No., eu encontrei que nós todos apreciamos o valor do excellence, para que eu sou sempre thankful. Mas eu digress.)
Recorde: Ao escrever para one's techies do companheiro, se deve ter que devem frequentemente absorver quantidades de informação voluminous em quantidades de tempo scant. Ao escrever para laymen, um deve fazer o texto tão delicado e fácil de digerir como possível, a fim de que não se tornem perdida em um oceano do geekspeak. Uma ou outra maneira, pondo pouco esforço extra em matérias do elegance e do estilo pode fazer um mundo da diferença.
Eu não entrarei no detalhe sobre o que constitui a técnica boa da escrita, como que seria além do espaço deste texto. Baste dizer que um programador ou um coordenador bom devem se certificar de que sua escrita é readable e bem-organizada, e de que flui lisamente de um tópico a outro.
Eu seria excitado além da opinião se eu nunca visse um outro manual slipshod, ou se eu nunca ouvisse uma outra história sobre desmoronar das companhias devido à documentação inexistente. Um fantasy impossível? Talvez. Ainda, eu espero que alguns techies para fora lá leiam esta mensagem, e que farão exame d ao coração.
Sobre O Autor
V. Berba Velasco tem um doctorate na engenharia elétrica e tem dobrado seu comércio por quase uma década. Durante esse tempo, descobriu repetidamente a importância da escrita técnica boa, e os pitfalls que podem ocorrer de ignorar seu valor.
O Dr. Velasco trabalha atualmente como uma Software Engineer sênior para a tecnologia celular limitada (http://www.immunospot.com, http://www.elispot-analyzers.de), uma companhia elétrica e do biotech em Cleveland, Ohio. Durante seu tempo de reposição, levanta pássaros do dodo, constrói cérebros e jogos humanos com sua coleção de monopoles magnéticos.
Artigo Fonte: Messaggiamo.Com
Related:
» Credit Secrets Bible» Cash Making Power Sites
» Home Cash Course
» Automated Cash Formula
Webmaster começa O Código do HTML
Adicionar este artigo para o seu site agora!
Webmaster enviar seus artigos
Nenhum registro necessário! Preencha o formulário e seu artigo está no Messaggiamo.Com Diretório!
