How to write user documentation [TechScribe technical writing for software] In many software companies, software developers write documentation for users.
![How to write user documentation [TechScribe technical writing for software]](http://cdn.pearltrees.com/s/pic/th/documentation-techscribe-21129773)
If you must write a user guide, a reference manual, or online help, where do you start? This article gives you guidance. The business case Typical reasons for creating user documentation are shown below: To help the users of your software.To decrease your support costs.To use as a marketing tool.To improve your company's image. Before you start to create the documentation, identify the reasons for creating the documentation. Do not create documentation to explain a clunky product.
Audience analysis Documentation has no use if it does not answer the questions that people ask. Possibly, some users know Windows and are subject-matter experts, but they have never used your software or your competitors' software. One way to categorize the audience is by job role. Data entry clerkSupervisorSystem administratorService desk operator. This method of categorizing the audience helps in two ways: Task analysis task. Doc 94. La documentation/Rédaction technique/Rédaction d'un manuel d'utilisation.
Un manuel d'utilisation, ou encore mode d'emploi, notice ou règle du jeu dans le cas d'un jeu, est un ouvrage devant permettre l'utilisation d'un produit : objet manufacturé (machine, outil, équipement de protection, …) ou logiciel.
Bien entendu, le manuel sera très différent selon le public visé (grand public ou spécialistes, opérateurs ou encadrement) et la complexité du produit. Cela va d'une simple affiche expliquant comment installer une imprimante, un petit livret de quelques pages indiquant les réglages d'un casque de vélo, jusqu'à plusieurs wagons de papier dans le cas d'un avion de combat. Le manuel peut être sur papier et/ou au format électronique : fichier PDF — il peut s'agir alors simplement du document papier à imprimer, ou bien d'un document avec des liens hypertextuels — ou aide en ligne — il s'agit alors d'une sorte de site Web. Ce wikilivre propose quelques considérations générales sur la rédaction d'un manuel d'utilisation. Du bon usage d'un traitement de texte. Un livre de Wikilivres.
Ce wikilivre est sur l'étagère Informatique. Ébauche Cette page est considérée comme une ébauche à compléter. Si vous possédez quelques connaissances sur le sujet, vous pouvez les partager en éditant dès à présent cette page (en cliquant sur le lien « modifier »). Ressources suggérées : Aucune (vous pouvez indiquer les ressources que vous suggérez qui pourraient aider d'autres personnes à compléter cette page dans le paramètre « ressources » du modèle? Les traitements de texte modernes sont conviviaux et simples d'utilisation. Ce guide propose de présenter un certain nombre de « bonnes habitudes » et de fonctionnalités qui permettent un meilleur usage d'un traitement de texte. En particulier, nous insisterons sur la séparation du fond et de la forme.
Si ce guide veut rester général, il doit cependant donner des exemples. Pour Microsoft Windows (MS Windows) et MacOS X, sans que cela soit limitatif. Tel écran, tel écrit…[modifier | modifier le wikicode]
Quelques conseils pour rédiger une procédure efficace. Revenons un instant sur une question qui intrigue et qui crée de vives discussions dans les entreprises : Comment rédiger des procédures ? Pour rappel une procédure est document qui décrit la manière d’accomplir une activité ou un processus. Une procédure doit à la fois répondre aux exigences de l’entreprise et créer les conditions d’une application efficace. Pour cela, deux conditions doivent être remplies conjointement : Le fond : le contenu de l’information doit être approprié, pertinent et suffisant.La forme : elle participe à la bonne compréhension de l’information et par conséquent à la mise en œuvre de la procédure. La forme participe également à la gestion de la procédure (identification, élaboration, diffusion, révision…).
Les qualités d’une procédure Le contenu d’une procédure (Qui, Quoi, Quand, Comment) Une procédure doit répondre à un besoin et non l’inverse. Pour décrire ces aspects, le logigramme semble être la forme la plus adaptée et plus universellement compréhensible.