|
VUE D'ENSEMBLE Vous, un non-écrivain, vient d'être attribué à écrire la documentation pour un produit de votre entreprise fabrique ou commercialise. Vous mai être stressé par la cession. N'ayez pas peur! Cet article va vous aider à démarrer sur la voie de la rédaction d'un document de succès. QUESTIONS ET REMARQUES Dès que vous avez affecté à la documentation du projet, vous devez commencer à prendre des notes et poser des questions. L'objectif majeur de ce début de la collecte d'informations est d'accéder aux sources d'information que vous aurez besoin pour écrire votre document. Ainsi, ces premières notes devraient être liées à l'endroit où vous obtiendrez votre information: les choses à lire et personnes à contacter, et un produit pour jouer avec. Astuce: Il ya toujours quelque chose à faire ou à apprendre sur un projet de documentation. Ne cessez pas de travailler pendant que vous attendez quelque chose d'autre à se produire. APPRENDRE LE BON USAGE DES OUTILS DE RÉDACTION DE VOTRE Ne soyez pas plongés dans les nouvelles technologies. Pour la plupart des entreprises et pour la plupart des projets de documentation, d'investir l'argent et de temps pour apprendre un Content Management System ou document exquise écriture de logiciels ne valent pas la peine. Écrire de la documentation est souvent la queue d'un projet, et vous n'aurez pas le temps d'apprendre les nouvelles technologies. Au lieu d'apprendre à tirer le meilleur parti de votre mot existant outils informatiques. * Connaître et comprendre pourquoi vous devriez utiliser votre traitement de texte "styles" pour le formatage de votre document. "Styles" (ou quelque soit votre traitement de texte les appelle) sont des ensembles de caractéristiques telles que la structure et le formatage. Par exemple, la rubrique (niveau 1) est un style, la rubrique 2 est un autre style, et ainsi sont titre, le corps du texte et d'autres. Lorsque vous appliquez un style à un bloc de texte, deux choses: (1) la mise en forme du style soit appliqué au texte et (2) Le traitement de texte sera en mesure de comprendre la structure du document. Les outils de traitement de texte va utiliser les titres pour générer automatiquement une table des matières. * Apprenez à utiliser la capacité décrivant votre traitement de texte. Le cerne attribue automatiquement des styles pour les titres dans votre document. La conception de votre document en utilisant la capacité de l'utilisateur décrivant votre traitement de texte. * Apprenez à utiliser le système de révision de votre traitement de texte. Le système de révision est une installation où l'auteur écrit un document et l'envoie ensuite à un examinateur. Le lecteur peut apporter des modifications au document, et la renvoie à l'auteur. L'auteur peut alors choisir d'accepter ou de rejeter chaque révision prévue par l'examinateur. Vous devrez être en mesure de traiter les révisions de plusieurs réviseurs pour chaque partie du document. La plupart des utilisateurs de traitement de texte ne savent pas comment utiliser le système de révision prévoit que leur logiciel. Vous pourriez souhaiter créer un document sur le système de révision pour votre avis. N'oubliez pas de leur dire ce que le système de révision est sur le point, ainsi que la façon de l'utiliser. La technologie vient en second. Notre objectif sera de produire un grand document, en fournissant les: * Contenu (les informations que votre lecteur a besoin ou envie) et * L'accès effectif à ce contenu (en donnant votre lecteur de la capacité de trouver ce qui est nécessaire). DOCUMENT DE TOUS LES GENS SUR LE PROJET Prétendre qu'elle est de 10 ans à compter de maintenant. Vous, ou quelqu'un d'autre devra réécrire la documentation utilisateur pour le produit que vous travaillez maintenant. Vous, ou quelqu'un d'autre doit être capable de communiquer avec ceux qui ont travaillé sur le projet d'origine ou les personnes qui les ont remplacés. Vous mai nécessité de leur poser des questions, ou tout au moins de trouver les notes et d'autres documents connexes au document qu'ils provoquaient. Vous devez tenir un registre de tous ceux qui ont travaillé sur le projet (pour le produit lui-même et pour la documentation utilisateur.) Les gens qui travaillent sur le projet sont les suivants (il y en mai en avoir d'autres, les inclure dans la liste): * Chef de projet * Ceux qui approuvera les parties du document, et qui sera approuvé le Document final * Project Team * Contacts * Marketing * Sources d'information * Editeur de document * Sous la direction de * Indexer Vous devriez garder (pour vous et l'équipe projet dans son ensemble) les renseignements suivants. Elle devrait avoir une entrée pour chaque personne à l'intérieur qu'à l'extérieur de l'organisation qui est affilié au projet, et ces données: * Nom complet * Rôle dans le développement des produits * Organisation et position de l'Organisation * Adresse e-mail * Téléphone de contact (numéro de télécopieur) * Adresse du bureau (si il ya une entreprise répertoire commun, obtenir l'adresse à partir de là, quand vous en avez besoin) * Leur expertise et leur ce qu'ils ont fait sur le projet * Toute autre information pertinente DO IT NOW: LISTE DES JOUEURS Créer cette liste de toutes les personnes liées au projet. Vous pouvez garder la liste en utilisant un traitement de texte, tableur, ou une adresse dédiée logiciel de livre et dans votre programme d'e-mail. Utilisez la méthode que vous êtes habitué à utiliser (un programme d'ordinateur est la meilleure, car elle permet d'éditer la liste, puis de les partager avec les autres membres de votre équipe de projet). Inclure les informations que j'ai suggéré plus haut sur chaque participant. Le but est de savoir qui a travaillé sur le projet, leur rôle dans le projet, et comment les contacter. Gardez la liste à jour. Votre patron Appelons la personne qui vous assigne la tâche de rédiger le document (ou une partie d'elle) votre "Patron". C'est la personne qui est responsable de s'assurer que la documentation se produit. Il ya plusieurs choses que vous devez demander à votre patron, et vous devez noter soigneusement les réponses. En fin de compte, votre patron doit vous fournir (ou vous mettre en contact avec quelqu'un qui peut vous fournir avec): * L'accès à la littérature sur le produit Comprend la commercialisation, la conception, la notion d'information, la documentation de produits similaires, bref, tout ce qu'ils vous permettra de lire qui pourrait être liée au produit. Une fois que vous obtenez la documentation écrite, lire autant que vous le pouvez sur le produit. Un objectif est de devenir l'expert sur le produit. * Accès aux membres de l'équipe projet. Non seulement les noms et coordonnées, mais aussi fournir le poids "pour amener ces gens à fournir des informations pour vous. Ceci est d'une importance vitale! Cet accès doit inclure les équipes de marketing et de design. Ils peuvent vous parler des utilisateurs potentiels du produit. * L'accès au produit lui-même ou une maquette du produit. Ainsi, vous pouvez acquérir une expérience pratique avec le produit. L'accès aux utilisateurs de produits similaires; l'accès aux utilisateurs potentiels de ce produit (ou des informations à leur sujet) Si vous avez été embauché, par exemple, le Département des Ressources humaines de l'entreprise, puis des ressources humaines aura pour vous orienter vers la personne sur le projet qui est votre Patron. Votre patron n'est pas votre client. Dans le monde des affaires, nous parlons de notre «client». Qui est habituellement la personne ou l'organisme qui engage et paie nous. C'est celle que nous travaillons. Cependant, en réalité, votre client est votre lecteur. Il est de votre responsabilité de faire le meilleur emploi de votre lecteur. S'il est nécessaire d'aller contre l'arrêt de votre patron, vous devez être prêt à convaincre votre patron sur le fond de votre façon de faire le travail. Lire tous les documents que vous pouvez obtenir sur le produit et le projet. Ce sera à vous préparer pour les échanges que vous aurez plus tard avec les membres du projet. Soyez prêt en sachant que les informations générales que vous pouvez avant d'avoir votre première session de collecte d'informations (réunion). Demander: «Que puis-je lire ou faire afin d'obtenir les information sur cette question? Vos premières investigations devraient viser à répondre à ces questions: 1. Dans l'ensemble (bref) Description du Produit. Que fait le produit fait pour l'utilisateur; Comment fonctionne le produit changer la façon dont l'utilisateur n'a actuellement choses. 2. Auditoire cible (les utilisateurs) pour le document et le produit Il s'agit du marché "cible" pour le produit, des informations sur qui va utiliser le produit. Cette information pourrait provenir de la commercialisation et les groupes de conception pour le produit. Demandez-leur: «Parlez-moi votre nom d'utilisateur potentiel de ce produit? 3. Objectifs du document que vous rédigez Il s'agit de la «portée» du document ... Quel est votre document supposé traiter de ce produit. Voir l'article suivant sur cette liste, point 4. Est votre document à un manuel utilisateur, manuel de référence, Guide d'installation, ou une combinaison de ces éléments? 4. Sont là pour être tout autre document de l'utilisateur à produire qui sont liés à ce produit? Autrement dit, est le document que vous travaillez sur une partie du document utilisateur définis que l'organisme de produire pour le produit? Si oui, quelles sont les autres documents dans l'ensemble (ainsi vous pouvez y faire référence dans votre document)? 5. Les informations de contact que j'ai parlé juste au dessus. Pour toute question que vous pourriez avoir, vous devez disposer d'une source (être que source écrite ou verbale) pour une réponse. Les éléments de la liste ci-dessus seraient probablement répondu par «niveau supérieur» membres de l'équipe projet. Peut-être votre patron ne peut leur répondre, sinon, il / elle doit vous guider à l'endroit où (ou de qui), vous pouvez obtenir les réponses. Ce sont les premières choses que vous écrirez dans votre documentation utilisateur. Obtenir cette information au début du projet. En bref, vous avez besoin d'obtenir les deux documents écrits sur le produit et les contacts à qui vous pouvez demander de fournir plus d'informations. Vous finirez par entrer ces informations dans un document de traitement de texte que vous pouvez partager. Document ensemble de ces informations. DEMANDEZ À PROPOS DE LA MÉCANIQUE Très tôt dans le projet de documentation, vous devriez demander à votre contact initial par écrit sur ces sujets-mécanique: * Quel est le délai pour produire la documentation. Quand devez-vous d'avoir terminé l'écriture de sorte qu'il peut être édité et publié. * Quels sont la Société (votre société, groupe, division) Lignes directrices et des normes de documentation Regarder par-dessus un peu de documentation acceptable fabriqués par la société * Quelles sont les lignes directrices pour la documentation juridique Vous aurez besoin de cela pour des disclaimers, information sur la sécurité et la notice de copyright * Comment le document et les composants de celle-ci doivent être approuvés par les responsables pour le produit et sa documentation. Veiller à ce que vous savez quand et comment les composants ou les étapes du document doivent être approuvées. Savoir qui est l'approbation de votre écriture. Restez en contact étroit avec ces gens. * Qu'est-ce écrit et décrit les logiciels utilisés dans l'entreprise Votre logiciel devrait être compatible avec celui de la Compagnie * Obtenez un Style Manual Un style manuel est un guide de sélection des phrases. Il fixe par écrit de douane pour votre industrie ou de l'entreprise. Par exemple, le guide de style pour la communauté d'indexation dit que le pluriel de "l'index" est «indices» et non «indices». Un guide de style mathématiques choisissez «indices», comme le pluriel de "l'index". Si votre entreprise a adopté un style de manuel, utiliser celui-ci, le cas échéant sur le produit. Dans le cas contraire, rechercher une librairie en ligne pour "Style Manual" ou "Style Guide» et votre secteur d'activité, comme «Style Manual mathématiques». * Que faites-vous de livrer sur ce projet? * Comment le document soit publié Imprimés, en ligne, Adobe Acrobat PDF, aide contextuelle, XML (il peut donc facilement se manifester sur n'importe quel support d'affichage) Gardez la trace de toutes ces informations. Vous pourrez les organiser et y ajouter, comme vous cela bouge documentation relative au projet de l'avant. Donner quelques informations Vous devez donner à chacun de vos coordonnées afin qu'ils puissent entrer en contact avec vous. Vous pouvez envisager d'utiliser votre carte de visite, et à écrire sur ce que vous écrivez le Document de l'utilisateur pour n'importe quel produit. Rendez-le facile pour vos contacts à prendre contact avec vous. Veiller à ce que vous avez vos informations de contact dans des e-mails ou des copies du document que vous envoyez à d'autres. Vous devriez également dire à votre patron comment vous prévoyez d'écrire la documentation. Vous serez la rédaction du document en morceaux sujets (qui sont logiques ou modules), et de fournir les pièces aux membres de l'équipe produit pour examen. Aussi (sauf si vous êtes un écrivain professionnel, auquel cas vous ne mai la plupart des modifications vous-même) faire savoir que vous envisagez d'utiliser une autre personne de modifier votre document. Documentation provisoire que vous fournissez pourraient ne pas être édité, vous leur fournissez pour que les commentateurs ( «experts» au sein de l'équipe du projet ou de la commercialisation) afin de les évaluer sur la complétude et l'exactitude. Vous aurez à assurer la clarté de l'écriture dans la (plus tard) les cycles d'édition et de révision. Un de mes (idéal) des objectifs pour vous est que vous devenez l'objet de tous les utilisateurs l'information axée sur le produit. Vous devenez la ressource que les autres sur le projet de tourner pour obtenir de l'information. Je pense que vous devez fournir des informations aux personnes concernées (et surtout celles qui doivent être impliqués à un stade ultérieur du projet, tels que l'indexeur) le plus tôt possible dans la vie du projet. Il ya plusieurs avantages à cela: * Ils vont s'informer et de réfléchir sur le produit et par projet. Ce sera le cas car les gens ne veulent faire du bon travail ... après tout, c'est leur gagne-pain. * Il y aura moins de surprises. Les gens savent ce qui se passe avec le projet, comment leurs rôles et le calendrier pourrait changer. Encouragez vos lecteurs à commenter retour à vous au sujet de tout ce qui concerne votre travail. Apprendre, apprendre, apprendre! Devenir l'expert sur le produit et sa documentation. CREER UNE RESSOURCE DE PARTAGE DE L'INFORMATION Je crois au partage de l'information ... c'est en fait un meilleur environnement de travail et un meilleur produit. Utiliser la technologie pour tout ce dont vous disposez pour créer (ou obtenir créé) une sorte de ressource à partager l'information. Cette information sera sous la forme de fichiers informatiques ... magic rien. Vous mai être en mesure d'utiliser un répertoire partagé sur un réseau local ou une aire protégée sur l'intranet de votre entreprise. Enquêter sur ce qui est nécessaire. Fournir la fonction lecture et en écriture à toutes les personnes (à l'intérieur de l'entreprise) qui sont impliqués sur le projet. Une des premières choses à poste est la liste des personnes sur le projet. Assurez-vous que tout ce que vous publiez, il est dans une forme que tout le monde qui a accès à elle peut lire (et éventuellement écrire) il. PROCHAINES ÉTAPES Autres articles dans ce «nouveau rédacteur technique" série vous aidera que vous progresserez dans le projet d'écriture. Vous les trouverez dans les liens dans la section «Ressources». |