Comment décrire les documents de rédaction technique. Un document bien écrit n'est pas créé par hasard. Le matériel couvert dans un rapport, un manuel ou un autre document technique est planifié, organisé puis écrit. L'étape de préparation d'un document est une étape clé et il est probable que les informations ne seront pas présentées logiquement si un plan n'est pas créé. Les contours permettent à l'auteur de réfléchir aux informations qui devraient ou ne devraient pas être incluses.
Réfléchissez sur vos idées. Notez toutes les idées dans votre plan qui, selon vous, devraient être incluses dans le document technique. Ne vous inquiétez pas de l'ordre des informations. Il importe simplement que toutes les informations soient incluses dans le processus de brainstorming.
Déterminez le but du document technique. Posez-vous des questions telles que: qui lira le document, pourquoi sera-t-il lu et comment sera-t-il utilisé.
Décidez du type de contour que vous souhaitez créer: historique, chronologique, spécifique au général, petit à grand, simple à complexe ou toute autre forme appropriée au contenu. Pensez au public et aux informations que vous souhaitez présenter. Assurez-vous que la manière dont les informations sont organisées est la plus cohérente pour le type d'informations présentées et pour le public qui lira le document technique.
Organisez les informations dans l'ordre approprié. Un schéma consiste à regrouper les informations en sections et niveaux logiques. Vous pouvez créer des sujets principaux, des sous-sujets et des sous-sous-sujets.
Terminez le plan en examinant les informations pour vérifier que les sujets sont organisés de manière appropriée et logique. Assurez-vous que vous ne manquez aucun fait clé. Supprimez toutes les informations non pertinentes pour le document technique.
