Remarques :
• Les chapitres de ce manuel ont été traduits avec OpenAI et peuvent contenir des erreurs. Si vous trouvez des problèmes avec les traductions, veuillez envoyer des corrections à l'auteur à admin@mcmassociates.io.
• Si vous trouvez des technologies obsolètes ou inexactes ici, vous êtes également invités à envoyer des corrections. Cependant, souvenez-vous que c'est un livre sur l'écriture technique, pas un manuel de technologie— les technologies plus anciennes peuvent toujours fournir des exemples utiles.
• Faire un don pour maintenir Manuel en ligne de rédaction technique gratuit.
• Pendant que vous êtes ici, envoyez à David un e-mail amical : admin@mcmassociates.io
Un grand changement est survenu dans ce livre en ligne de rédaction technique : il utilise maintenant document technique (doctech pour abréger) pour désigner tout document contenant des informations techniques — plutôt que d'utiliser rapport. Le rapport est une sous-catégorie avec les autres types de documents techniques discutés dans ce livre.
Introduction : Rédaction Technique
- Quoi de neuf ?
- À propos de la rédaction technique
- À propos des cours de rédaction technique
- Ressources
- À propos de l'auteur
- Remerciements
- Liens vers des ouvrages de référence
Applications de l'écriture technique
Remarque : Ce manuel en ligne utilise maintenant document technique, ou juste techdoc, dans les cas où rapport est trop spécifique. (Les emblèmes de l'ONU) indiquent que des traductions sont disponibles si vous suivez le lien.
- Enquête sur les documents techniques
- Documents d'affaires et d'emploi :
- Rapports de données
- Plans d'affaires
- Propositions
- Rapports de recommandation et de faisabilité
- Blancs papiers
- Rapports de progrès
- Instructions
- Rapports de fond
- Rapport de conception en ingénierie
- Manuels d'utilisation orientés vers la technologie
- Spécifications et fiches techniques
- Notes de version
- Cas d'utilisation, études de cas
- Politiques et procédures opérationnelles standard
- Rapports de recherche primaire. Pour le laboratoire et le terrain.
- Revues de littérature
- Guides et documents d'orientation
- Manuels
- Matériel de devant et de derrière:
Structures d'information
Les structures d'information sont utilisées comme parties de documents plus longs, mais peuvent également être utilisées comme des documents à part entière, en particulier pour des projets d'écriture technique. Ces structures d'information sont un bon point de départ pour les personnes en écriture technique de développement.
Conception de document
- Aperçu de la conception de Techdoc
- Aperçu de la conception du livre
- Aperçu de la conception de la page
- Titres
- Listes
- Avis spéciaux
- Nontextuels : tableaux, figures, graphiques
- Format Techdoc et emballage final
- Mise en lumière et emphase
- Indexation
Processus et Directives en Rédaction Technique
- Processus d'écriture : de l'audience au brouillon
- Analyse de l'audience
- Analyse de tâche
- Traduction d'informations techniques
- Techniques de révision puissantes
- Traitement de l'information
- Collecte d'informations (NoodleTools ou Carnet LM)
- Citations, Paraphrases, Résumés : Formulation, Ponctuation, Attribution
- Modèles et éléments de base de la phrase
- Problèmes courants de grammaire, d'utilisation et de ponctuation
- Problèmes d'orthographe courants
- Stratégies pour la révision par les pairs et l'écriture en équipe
