Écriture technique pour terrifiée
Introduction
Parfois ce peut être au delà d'budget de compagnies ou d'individus pour louer un auteur professionnel pour adresser leur documentation technique. Bien que dans un monde idéal toute la documentation technique devrait être produite par un expert fortement qualifié, malheureusement nous ne vivons pas dans un idéal. De la même manière que beaucoup de gens essayeront de réparer leurs propres appareils ménagers, beaucoup de gens essayeront d'écrire à qualité les documents techniques. Juste comme jouant du violon un grille-pain peut avoir comme conséquence l'électrocution, essayer d'écrire les documents techniques à partir de zéro sans conseil antérieur aura finalement comme conséquence l'échec. Comme un principe de base approximatif que vous devriez toujours chercher pour employer un spécialiste, mais si pour quelque raison vous ne puissiez pas et vous sont les malheureux pauvres qui ont eu des fonctions de documentation refilées sur elles, ne désespérez pas. Ce guide de dossier décrit certains des qualifications de noyau que vous devrez apporter à votre écriture, de progiciels techniques de conventions à se rendre compte de, vous pouvez considérer, et de choses définies à éviter. Si tout va bien même si vous n'avez jamais écrit une phrase dans votre vie au sujet de n'importe quoi vaguement technique vous aurez pour le moins, une plus large image de ce que l'écriture technique nécessite.
Quelle est écriture technique ?
L'écriture technique assez unsurprisingly, se rapporte à l'écriture qui est technique. Bien que ceci puisse sembler comme une définition fallacieuse, il est important à se rappeler. Trop d'auteurs techniques font l'erreur de créer la documentation qui est ou trop technique, ou trop 'littéraire '. Un bon auteur technique devrait pouvoir ajuster l'équilibre entre les deux pour convenir à l'utilisateur de la documentation. L'écriture technique est beaucoup comme invisible dominant mais joli d'air frais, beaucoup. Dans de monde de câble étrange en lequel nous nous trouvons, l'écriture technique est partout. Les manuels de logiciel, les guides d'utilisateur pour les appareils ménagers, les feuillets d'instruction, les email, les lettres, les rapports, les rapports de nouvelles techniques, les statistiques et les biographies sur des sports de télévision montre que tous sont des exemples de l'écriture technique auxquels les gens sont exposés à quotidiennement. Si vous avez jamais essayé de programmer les arrangements de temps sur un magnétoscope à la maison et avez jeté le manuel à travers la salle dans le dégoût, vous avez jeté un morceau d'écriture technique (bien qu'évidemment pas très bonne !).
Un trop grand nombre chronomètre la littérature technique est produit par des auteurs avec pas une assez grande prise de technologie, ou des technologues qui manquent d'une capacité d'écrire. Comme un auteur technique éventuel vous doit marcher la ligne très sensible d'être techniquement bien informé dans votre field(s) de spécialiste aussi bien qu'être un 'bon 'auteur (par opposition aux 'mauvais 'auteurs qui peuvent habituellement s'avérer attaquer de vieilles dames douces ou quelque chose). La documentation technique est habituellement produite pour deux groupes d'utilisateur distincts, à savoir utilisateurs de niveau experts, et utilisateurs naïfs. Pendant qu'un auteur technique un de votre premier charge doit trier pour quelles assistances vous écrivez, au lequel m'apporte habilement :
Connaissez l'ennemi thy
Comme le vieux cliché disparaît, chacun un critique. C'est particulièrement vrai de la réaction de la plupart des personnes raisonnables une fois confronté à l'écriture technique. Comme a été accentué dans l'exemple du magnétoscope ci-dessus, l'écriture technique peut être impénétrable à l'utilisateur. Si c'est le cas, il est parce que celui qui a écrit la documentation, n'a pas pris la peine d'identifier leurs assistances et d'écrire à leur niveau. Ce semble un point évident à faire, mais un qui est souvent donné sur, que l'utilisateur des documents vos créent, peut réellement ne pas être un expert. Évidemment si vous créez un document sur un produit particulier de spécialiste pour un groupe d'utilisateur avançé particulier (un bon exemple pourrait apurer le logiciel pour des administrateurs de système informatique) alors que vous devrez composer ceci est une manière entièrement différente que si vous créez par exemple, un manuel technique pour le logiciel d'ordinateur de marché grand public avez visé l'utilisateur à la maison inexpérimenté. Un du premier vous charge doit accomplir avant que vous mettiez même le stylo au papier, du doigt au clavier, doit identifier qui l'utilisateur de vos documents sera et construira des documents visés que group(s) particulier de cible. Si vous obtenez cette étape correcte, elle devrait éviter vos documents étant jetés à travers des salles dans l'ennui !
Planification pour la perfection
Une fois que vous avez identifié la cible pour les documents que vous créerez, vous devrez commencer à projeter comment les documents seront organisés. Ce processus dépend en grande partie de quelle documentation est produite, mais vous pouvez suivre quelques principes de base approximatifs. Premièrement, si les documents doivent soutenir un produit particulièrement détaillé (tel qu'une application informatique) obtenez vos mains sales là-dessus aussi rapidement que vous pouvez. En examinant le produit en détail vous pouvez formuler un plan d'attaque et commencer à composer une structure d'organisation. Tandis que vous explorez le produit en détail, les notes copieuses de prise, en tant que faire ceci pendant les étapes exploratoires initiales peuvent vous sauver le temps qui peut être absolument essentiel si vous travaillez à la date-limite. Même à l'étape de planification que vous devez vous assurer là est une uniformité à la disposition, et structure d'organisation pour le document. Choisissez les conventions de numérotation, divisez en paragraphes les modèles, et produisez des idées approximatives pour la disposition maintenant, et économiser le temps essentiel plus tard.
Laissez une ébauche dedans
Avant de plonger en avance dans créer la documentation, ébauche hors de chaque section d'abord. Ceci laissera commander à nouveau si les documents étant créés n'ont pas un 'écoulement 'logique sans sérieusement avoir l'impact sur le projet. Beaucoup de documents techniques (particulièrement pour des produits plus détaillés) se composent de nombreuses (et dans certains cas pratiquement innombrables) itérations. C'est parce que le produit décale et change le temps fini, et une des principales fonctions d'un auteur technique doit suivre les progrès de ces changements, et s'assurer qu'ils sont tous bons documentés. Les bons auteurs techniques pousseront toujours leurs documents par autant d'ébauches comme humainement possible, en raffinant sur chaque ébauche, jusqu'à ce qu'eux arrêtent une position par lequel eux (et leur employeur) soit satisfaits qui la documentation est opportune, précise et une réflexion vraie du produit ou traitez-le documente.
Le diable est dans le détail
En tant qu'écriture déjà identifiée et technique s'appelle cela parce qu'il est technique en nature. Une partie d'être technique doit être précise, et une partie de précision doit être aussi détaillée comme humainement possible. Même si les documents que vous créez sont pour un avançé et le groupe d'utilisateur technologiquement sophistiqué, votre documentation doit se concentrer sur les détails d'un processus, ou pour employer un produit. Ceci peut être un exploit difficile à accomplir, mais pas si vous écrivez à vos assistances. Ne supposez jamais que le lecteur sait que quelque chose au sujet du produit ou du processus soit documenté, mais dans le cas d'utilisateurs avançés/experts ayez au moins le bon sens d'identifier le fait qu'elles n'ont pas besoin probablement d'être dites comment utiliser l'équipement qu'elles actionnent quotidiennement. En décrivant comment effectuer une activité particulière ou la charger, identifiez chaque étape impliquée (numérotez-les si ceci adapte les conventions du type de document que vous créez) et assurer l'exactitude de ce que vous lui avez écrit essai vous-même, ou même l'améliorer, corde dans un volontaire du même niveau de qualifications que l'utilisateur.
Choisissez l'outil droit pour le travail
Bien qu'il soit possible de créer les documents techniques en utilisant le parchemin et le sang, il n'est pas recommandé. Beaucoup d'applications de logiciel de spécialiste existent pour vous aider à créer la documentation puissante, et une partie de vos fonctions en tant qu'auteur technique, incluent choisir l'outil droit pour le travail. En grande partie ceci dépend de la nature des documents étant produits, et de la nature de leur distribution certaine. Si les documents peuvent être fournis en utilisant l'Internet, c'est certainement une avenue à considérer. À cet effet servez-vous des paquets tels que le MX d'instantané et le Dreamweaver pour réaliser ce but. L'aide en ligne intégrée, vous pouvez souhaiter créer les documents crus de HTML, ou choisir alternativement un paquet de spécialiste tel que RoboHelp ou semblable. Dans le cas des documents basés d'impression, vous devrez choisir un progiciel assez puissant pour manipuler ce que vous jetterez à lui.
Beaucoup d'auteurs techniques inexpérimentés tournent immédiatement vers Microsoft Word (car il est omniprésent peut dedans les environnements commerciaux et privés). À moins que votre documentation aille être sous 150 pages, et vous savez créer des calibres et faire des macros, évitez la MME. mot. Car n'importe quel auteur technique vous dira elle a des habitudes méchantes toutes qu'elle doit posséder, et peut souvent être un paquet instable à travailler avec. Si vous créez la documentation lourde de graphiques, vous pouvez souhaiter considérer Quark Xpress, ou choisissez potentiellement le leader de l'industrie dans le domaine, adobe Framemaker. Quelque logiciel vous choisissiez, vous devez vous assurer devenez incroyablement compétent avec lui, par l'investissement dans la formation, ou en l'employant jour après jour après jour !
Communiquez que ce que vous êtes payé pour faire !
Beaucoup de gens vous diront que créer la documentation technique est pénible et réitéré. Ces personnes, sont erronées, et probablement des débiles aussi. Bien que vous puissiez trouver le processus de créer la documentation technique 'étant ennuyeuse '(si vous faites vous êtes dans le travail faux !) il n'est pas. Créer les documents techniques de qualité est une étape essentielle en permettant des personnes emploient à en juste proportion et correctement la technologie. Bien qu'aucun utilisateur n'approche la documentation que vous créez comme elles approchent un roman, vous pouvez finalement les aider à réaliser ce qu'elles veulent réaliser en utilisant la technologie. N'importe comment 'mat 'le processus peut sembler être, permettre à des utilisateurs de réaliser leurs buts en lisant vos documents devrait vous donner des précipitations de fierté et en effet, bonheur. Aussi longtemps que vous vous rappelez les effets positifs que la technologie peut avoir les vies des personnes, quand vous créez vos documents vous pouvez communiquer plus efficacement, car vous serez plus heureux dans le processus communicatif. Dans tout le cycle de vie de documentation, vous devriez chercher à communiquer avec des collègues aussi souvent comme possible (si c'est approprié). Laissez-les lire vos documents, écouter leurs critiques, et ajuster vos documents (si vous ne pouvez pas discuter votre coin !). Un auteur technique est payé pour communiquer, s'assure que vous , et pour ne jamais oublier à pourquoi votre communiquent, et à qui, dans les documents eux-mêmes.
Erreurs communes pour éviter fabrication
En créant les documents techniques là soyez un certain nombre de pailles mortelles que vous pouvez faire. Bien que nullement approfondie, cette section détaille certaines des erreurs plus communes que les nouveaux auteurs font, dans les espoirs que vous éviterez de les faire trop :
Étant Patronising - bien que la documentation technique devrait être claire, elle devrait jamais pas patronising. Vous ne créez pas des documents à lire par des débiles mais des consommateurs et des clients. Vous devriez toujours écrire au niveau de qualifications de vos assistances, mais n'importe ce que les personnes de niveau techniques sont en ligne, elles ne sont pas des débiles. Même les enfants obtiennent offensés quand patronised, ne font pas cette erreur avec quelqu'un qui paye votre salaire, enfant ou autrement.
Abus d'humeur - les gens ne lisent pas les documents techniques à amuser, ils les lisent dans les espoirs de compléter avec succès un processus, ou d'extraire l'information. À moins qu'il soit approprié à l'utilisateur, évitez l'humeur dans la mesure du possible. Si vous écrivez un livre, une amende et un bon. Si vous écrivez un manuel, évitez l'humeur comme la peste, car le plus souvent les utilisateurs manqueront la plaisanterie et l'extrémité juste détestant vers le haut l'idiot patronising qui a écrit la documentation.
Contradiction - même à l'étape de rédaction, vous devriez vous assurer que tous les éléments utilisés dans votre document sont conformés. Ceci s'applique autant à l''tonalité 'du document quant à la disposition de lui. Assurez-vous l'utilisation à sens conformés (premiers personne, etc...) aussi bien que la disposition de page, les éléments de paginations, les en-têtes et les titres de bas de page, et tous autres éléments textuels.
Preuve lue - vers la fin de créer un morceau de documentation technique, vous serez probablement malade de la vue d'elle. Cela n'importe pas. Ce qui importe est ce qui part de votre bureau ou à la maison, est précis. À cet effet la preuve a lu le document dans tous tous que c'est des ébauches, et avant qu'elle soit distribuée la preuve l'a lue encore, et encore, et encore. Ne comptez jamais sur des contrôleurs de charme (elles jamais travail) et si vous pouvez l'éviter, ne comptez seulement jamais sur votre propre jugement. Obtenez votre document lu par autant de paires d'yeux comme possible avant la distribution, après tout, elles pourraient repèrer l'une chose que vous avez étée absent dans tout le procédé de création.
Conclusion/promotion sans scrupule d'art de l'auto-portrait
L'écriture technique n'est pas indépendamment de ce que vous pouvez penser, un travail facile. Elle exige l'expertise, la patience et un mélange très impair des qualifications. Juste comme n'importe quel autre travail, vous pouvez apprendre comment à faites-le, mais même cette instruction ne vous fera nécessairement aucun bien à elle. Pour être un bon auteur technique, vous devez être anal pourtant créateur, focalisé pourtant communicatif, et un expert flexible. Ce, comme vous pouvez imaginer probablement, n'est aucun simple chargent. Bien que vous puissiez penser que créant les documents techniques est facile, la documentation précise, conformée et opportune de créer à un niveau commercial élevé est un rôle fortement provocant. Indépendamment de votre budget, à la longue elle fournira le ROI significatif si vous louez un spécialiste. Après tout, ils pourront faire en jours, ce qui vous déchirez vos cheveux notre essayer d'accomplir en semaines si pas des mois.
Au sujet De l'Auteur
Au cours des années Mike Kemp a été utilisé en tant qu'indépendant IL journaliste (travaillant pour des publications telles que le registre, le Namesfacesplaces, le foyer de sécurité et le Packetstorm), un redacteur publicitaire, un concepteur de jeux vidéo, un auditeur de sécurité, un concepteur d'enchaînement, un concepteur et LUI entraîneur. Il a travaillé dans une variété de positions indépendantes et permanentes pour les deux petits (par exemple deux hommes et compagnies d'un chien) aux organismes multinationaux dans l'ensemble du R-U et de l'Europe. En ne travaillant pas à de divers articles, des livres, manuels, et assorti l'autre copie pour des clients, Mike peuvent habituellement s'avérer travailler fort sur une variété de romans non publiés. Il a eu plusieurs de ses scénarios courts produits par les compagnies indépendantes de production, et travaille actuellement sur plusieurs des manuscrits de longueur de dispositif.
Mike vit la plupart du temps heureusement dans une banlieue terriblement un-de Bohème de Londres avec son (et long-souffrant) associé à long terme, et deux ont trompé des chats. Pour apprendre plus au sujet de Mike, la gamme des projets il a été comporté dedans, et l'autres substance et non-sens assortis, visitent svp son homepage personnel à www.clappymonkey.com.
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!
