Les cinq erreurs principales que les compagnies font en ce qui concerne la documentation technique
Je l'ai vue maintes et maintes fois. Une des faiblesses les plus communes que j'ai vues aux compagnies-en effet de technologie, presque un universel défaut-est le manque de documentation technique appropriée. Certains riraient ceci au loin comme détail mineur ; cependant, les répercussions sont souvent graves. Le futur entier d'une compagnie peut être fait ou perdu basé sur la quantité d'attention qu'elles prêtent à cette issue.
Au cours des années, j'ai identifié cinq problèmes qui j'ai trouvé pour être particulièrement commun quand il vient à la documentation technique d'écriture. Je voudrais partager ces pensées avec vous, dans l'espoir d'empêcher d'autres de tomber en bas des mêmes chemins.
1. Ne pas avoir tous manuels d'utilisateur
Ne riez pas. Ceci peut sembler comme un erreur-absurde assez fondamental, égal-mais c'est étonnamment terrain communal. J'ai rencontré beaucoup de compagnies qui ne fournissent pas des manuels d'utilisateur pour leurs produits, ou dont les manuels sont skeletally minces ou des années démodés. En fait, j'estimerais qu'environ la moitié des petites compagnies de technologie que j'ai rencontré l'entrer dans cette catégorie. (naturellement, on rencontre rarement ce problème en achetant le logiciel ou l'électronique grand public disponible immédiatement. Parmi des ingénieurs cependant, c'est une histoire de façon déprimante familière.)
Je me rappelle comment un ingénieur m'a dit pourquoi sa compagnie n'a fourni à aucun manuel d'utilisateur leurs produits. Dans des tonalités faites calmer dit-il "il est parce que nous ne faisons aucun argent en écrivant des manuels. Ce n'est pas une entreprise d'acquisition de l'argent, ainsi notre gestion ne veut pas perdre le temps sur ceci." Une expression gênée a rampé dans son visage, alors il s'est penché plus étroit et dit, "nous avons perdu tant de clients parce que nous n'avons pas la documentation décente. Parlez d'être penny-sage, livre-idiot!"
Elle n'est pas simplement les clients qui souffrent quand les manuels sont insatisfaisants ou inexistants. Que diriez-vous des employés eux-mêmes ? Que se produit quand un nouvel ingénieur vient à bord, et doit apprendre rapidement ? Ou que se produit quand les ingénieurs existants doivent se familiariser davantage avec des aspects peu familiers de leurs produits ? La documentation d'utilisateur, si correctement écrite, peut fournir une manière douce et efficace d'apporter jusqu'à la vitesse. Sans elle, ils seront forcés pour se fonder plus fortement sur d'autres ingénieurs pour les instruire, de ce fait perdant la période de chacun concerné. Semaines, si pas des mois, de la main d'oeuvre valable peuvent être gaspillés de cette fa4con.
2. Ne pas avoir la documentation interne appropriée
Elle n'est pas simplement la documentation d'utilisateur sur laquelle les compagnies font défaut. La documentation interne est fréquemment un accident aussi bien, car les compagnies brouillent pour libérer un produit. Dans leur rapidité pour mettre des produits sur le marché, les compagnies laissent souvent leurs documents internes de conception tomber désespérément par le bord de la route.
Il n'aide pas que les programmeurs et les ingénieurs sont notoires pour avoir des qualifications de communication de lackluster, et que la documentation est un charger qu'elles apprécient rarement. J'ai rencontré beaucoup de compagnies de logiciel, par exemple, dont les conceptions de logiciel étaient un désordre insurmontable dû à leur manque de documents architecturaux, des descriptions d'interface et des commentaires de dans-code. Tristement, j'ai vu les problèmes semblables quand il vient aux conceptions mécaniques, conceptions électroniques, méthodes de fabrication ? vous l'appelez.
J'ai parlé aux ingénieurs dont les compagnies sont allées dessous, ou avais chancelé sur le bord. Presque invariablement, le manque de à documentation proportionnée a été un facteur important dans de telles situations.
Je dis toujours mes patrons et des collègues, "je veux m'assurer que mon travail est raccommodé bien a documenté. Si je quitte la société, ou si je meurs dans un accident de voiture, parce que moi voulez s'assurer que cette compagnie peut marcher dessus sans moi." Ce devrait être l'une des raisons principales derrière maintenir complet documentation-à s'assurent que la compagnie ne sera pas estropiée par absence de toute personne.
Malheureusement, beaucoup d'employés prennent la pointe opposée. Ils lésinent exprès sur la documentation, pensant que ceci leur assurera un certain travail sécurité-et parfois, ceci travaille. Cependant, un employeur futé sait qu'un ingénieur qui documente bien vaut la peine bien davantage qu'un autre ingénieur qui garde ses cartes près de son gilet. Le dernier peut être essentiel à court terme, mais finalement, il est une responsabilité à long terme.
3. Oublier ses assistances
Ce problème se produit souvent en développant la documentation d'utilisateur. Les programmeurs et les ingénieurs oublient fréquemment que leurs manuels vont être lus par les personnes qui sont peu familières avec leurs produits, ou qui n'ont pas les mêmes qualifications techniques. Je me rappelle une compagnie à la compagnie particulière-un de contrôleur de machine sur la côte occidentale. Leur "manuel d'utilisateur" était un mélange incongru horrible des acronymes, limites non définies et pensées apparemment aléatoires, avec environ les procédures une douzaine énumérées dans aucun ordre particulier. Leur documentation d'utilisateur a manqué des détails de base tels que comment commencer le contrôleur vers le haut, ou comment l'arrêter dans le cas de l'les détails urgence-critiques que n'importe quel utilisateur de débutant devrait s'attendre à ce que trouvent d'un manuel.
Un problème relatif est le manque d'employer la langue appropriée. Considérez le cas dans lequel plusieurs des lecteurs ne sont pas les anglais indigènes haut-parleur-disent, quand vente un produit en Europe ou l'Asie, ou en écrivant des procédures d'assemblée pour les ouvriers d'usine nés à l'étranger. Dans ces cas-ci, il peut être nécessaire de maintenir la langue assez simple. Si ce n'est pas possible-dites, en discutant les détails complexes qui exigent beaucoup de précision-un peuvent souvent compenser en ajoutant quelques diagrammes, diagrammes ou photographies convenable-choisis. L'une ou l'autre approche peut être utile en facilitant texte complexe un peu pour absorber.
4. Ne convenant pas graphique
C'est indéniablement cliché, mais néanmoins-un l'image vraie peint mille mots. De même, un manuel que l'utilisation judicieuse de marques des images et des diagrammes sera beaucoup plus facile de comprendre qu'un qui se composent entièrement de descriptions des textes.
Certains considèrent comme étant ceci enfantin et inutile. Je pas , et mon expérience a prouvé que la majorité d'utilisateurs apprécient avoir ces guides visuels. Rappelez-vous ; n'importe comment sophistiqué vos lecteurs soyez, ils sont toujours humain. Même un intelligent, autrement lecteur soigneux peut accidentellement manquer un certain détail important, particulièrement une fois encouragé le temps.
5. N'essayant pas d'obtenir l'excellence
Il est intéressant de voir comment les programmeurs et les ingénieurs peuvent essayer d'obtenir l'excellence dans beaucoup d'aspects de leur travail, pourtant prend l'exact vis-à-vis de l'approche quand elle vient à la documentation. "qui s'inquiète d'exprimer de toute façon?" J'ai entendu que beaucoup d'ingénieurs disent. "nous n'écrivons pas la poésie ou les scénarios ici. Ce qui importe est que la documentation doit être techniquement précise."
C'est une vue épouvantablement myope. L'exactitude technique est en effet importante, mais ainsi sont la présentation et le modèle. Peu d'ingénieurs écouteraient un demandeur du travail qui révèle dans un peignoir et des poussoirs, ou un mandataire de litige qui parle comme une vallée fille-et pourtant de façon ou d'autre, ces mêmes ingénieurs s'attendent à des leurs techies de camarade (ou plus mauvais, un client !) pour slog par des pages du méandre, texte mal exprimé. Importe même aussi fondamental que l'épellation, la grammaire et corriger sont souvent traités en tant que seuls détails ennui-musardants qui ne valent la peine rien davantage qu'un regard cursif.
(à mon soulagement, le démuni de I a rencontré des telles attitudes à mon lieu d'affectation. Je m'empresse de dire ceci, de peur que n'importe qui pensent que je me plains au sujet du peuple avec lequel je travaille ! Non, j'ai constaté que nous tous apprécions la valeur de l'excellence, pour laquelle je suis toujours reconnaissant. Mais je m'écarte.)
Rappelez-vous : En écrivant pour ses techies de camarade, on devrait considérer qu'ils doivent souvent absorber des quantités de l'information volumineuses dans des quantités de temps limitées. En écrivant pour des laïques, on devrait rendre le texte aussi doux et facile à digérer comme possible, de peur qu'elles deviennent perdues dans un océan de geekspeak. L'une ou l'autre manière, mettant un peu d'effort supplémentaire dans des sujets de l'élégance et du modèle peut faire un monde de la différence.
Je n'entrerai pas dans le détail au sujet de ce qui constitue la bonne technique d'écriture, comme qui serait au delà de la portée de ce texte. Suffisez pour dire qu'un bon programmeur ou ingénieur devrait s'assurer que son écriture est lisible et bien-organisée, et qu'elle coule sans à-coup d'une matière à l'autre.
Je serais fait frémir au delà de la croyance si je ne voyais jamais un autre manuel négligé, ou si je n'entendais jamais une autre histoire au sujet de s'effondrer de compagnies dû à la documentation inexistante. Une imagination désespérée ? Peut-être. Toujours, j'espère que quelques techies dehors là liront ce message, et qu'ils le prendront au coeur.
Au sujet De l'Auteur
V. Berba Velasco a un doctorat dans l'électrotechnique et avait manié son commerce pendant presque une décennie. Pendant ce temps, il a à plusieurs reprises découvert l'importance de la bonne écriture technique, et les pièges qui peuvent se produire d'ignorer sa valeur.
Dr. Velasco travaille actuellement en tant que Software Engineer principale électrique et pour la technologie cellulaire limitée (http://www.immunospot.com, http://www.elispot-analyzers.de), une compagnie biotechnologique à Cleveland, Ohio. Pendant son temps disponible, il élève des oiseaux de dodo, établit les cerveaux et les jeux humains avec sa collection de monopoles magnétiques.
Source D'Article: Messaggiamo.Com
Related:
» Credit Secrets Bible» Cash Making Power Sites
» Home Cash Course
» Automated Cash Formula
Webmaster obtenir le code html
Ajouter cet article sur votre site Web dès maintenant!
Webmaster envoyer vos articles
Aucune inscription requise! Remplissez le formulaire et votre article est dans le Messaggiamo.Com répertoire!
