Documentation - Documentation

Pour un guide sur l'utilisation de la documentation dans les modèles Wikipedia, voir {{ documentation }}

La documentation est tout matériel communicable utilisé pour décrire, expliquer ou donner des instructions concernant certains attributs d'un objet, d'un système ou d'une procédure, tels que ses pièces, son assemblage, son installation, sa maintenance et son utilisation. La documentation peut être fournie sur papier, en ligne ou sur des supports numériques ou analogiques , tels que des bandes audio ou des CD . Les exemples sont les guides de l'utilisateur, les livres blancs, l'aide en ligne et les guides de référence rapide. La documentation papier ou papier est devenue moins courante. La documentation est souvent distribuée via des sites Web, des produits logiciels et d'autres applications en ligne.

La documentation en tant qu'ensemble de matériel pédagogique ne doit pas être confondue avec la science de la documentation , l'étude de l'enregistrement et de la récupération d'informations.

Principes de production de la documentation

Bien que les normes ISO associées ne soient pas facilement accessibles au public, un guide provenant d'autres sources sur ce sujet peut être utile. , ,

Le développement de la documentation peut impliquer la rédaction, le formatage, la soumission, la révision, l'approbation, la distribution, le repostage et le suivi de documents, etc., et sont organisés par les SOP associées dans un secteur de réglementation. Cela pourrait également impliquer de créer du contenu à partir de zéro. La documentation doit être facile à lire et à comprendre. S'il est trop long et trop verbeux, il peut être mal compris ou ignoré. Des mots clairs et concis doivent être utilisés et les phrases doivent être limitées à un maximum de 15 mots. La documentation destinée à un public général doit éviter les termes sexospécifiques et les préjugés culturels. Dans une série de procédures, les étapes doivent être clairement numérotées. , , ,

Produire de la documentation

Les rédacteurs techniques et les communicateurs d'entreprise sont des professionnels dont le domaine et le travail sont la documentation. Idéalement, les rédacteurs techniques ont une formation à la fois dans le domaine et dans la rédaction, la gestion de contenu et l'architecture de l'information. Les rédacteurs techniques collaborent le plus souvent avec des experts en la matière (PME), tels que des ingénieurs, des experts techniques, des professionnels de la santé, etc. pour définir puis créer une documentation répondant aux besoins de l'utilisateur. Les communications d'entreprise comprennent d'autres types de documentation écrite, par exemple :

  • Communications de marché (MarCom) : les rédacteurs de MarCom s'efforcent de transmettre la proposition de valeur de l'entreprise à travers une variété de médias imprimés, électroniques et sociaux. Ce domaine de la rédaction d'entreprise est souvent engagé dans la réponse aux propositions.
  • Communication technique (TechCom) : les rédacteurs techniques documentent le produit ou le service d'une entreprise. Les publications techniques peuvent inclure des guides d'utilisation, des manuels d'installation et de configuration et des procédures de dépannage et de réparation.
  • Rédaction juridique : Ce type de documentation est souvent préparé par des avocats ou des parajuristes.
  • Documentation de conformité : ce type de documentation codifie les procédures opérationnelles standard (SOP), pour tous les besoins de conformité réglementaire, comme pour l'approbation de sécurité, la fiscalité, le financement, l'approbation technique et tous
  • Documentation sur les soins de santé : ce domaine de la documentation englobe l'enregistrement et la validation en temps opportun des événements qui se sont produits au cours de la prestation des soins de santé.

Documentation en informatique

Article principal : Documentation du logiciel

Les types

Les types de documentation logicielle suivants sont typiques :

Les types de documentation de matériel et de service typiques sont les suivants :

Outil Dossier de documentation logicielle (SDF)

Un type courant de document logiciel écrit dans l'industrie de la simulation est le SDF. Lors du développement d'un logiciel pour un simulateur, qui peut aller de dispositifs avioniques embarqués à des bases de données de terrain 3D en passant par des systèmes de contrôle de mouvement complets, l'ingénieur tient un cahier détaillant le développement « la construction » du projet ou du module. Le document peut être une page wiki, un document MS Word ou un autre environnement. Ils doivent contenir une section d' exigences , une section d' interface pour détailler l'interface de communication du logiciel. Souvent, une section de notes est utilisée pour détailler la preuve de concept, puis suivre les erreurs et les améliorations. Enfin, une section de test pour documenter comment le logiciel a été testé. Cela documente la conformité aux exigences du client. Le résultat est une description détaillée de la façon dont le logiciel est conçu, comment créer et installer le logiciel sur le périphérique cible, et tous les défauts connus et solutions de contournement. Ce document de construction permet aux futurs développeurs et mainteneurs de se familiariser rapidement avec le logiciel et fournit également une feuille de route pour modifier le code ou rechercher des bogues.

Outils logiciels pour l'inventaire et la configuration du réseau

Ces outils logiciels peuvent collecter automatiquement les données de votre équipement réseau. Les données peuvent être destinées à l'inventaire et aux informations de configuration. La bibliothèque ITIL demande de créer une telle base de données comme base de toutes les informations pour le responsable informatique. C'est aussi la base de la documentation informatique. Les exemples incluent la configuration XIA.

Documentation en justice pénale

« Documentation » est le terme préféré pour le processus de remplissage des bases de données criminelles. Les exemples incluent le National Centre antiterroriste de Terrorist Identities Datamart Environment ( « TIDE »), des délinquants sexuels registres et bases de données de gangs.

Documentation en éducation de la petite enfance

La documentation, en ce qui concerne le domaine de l'éducation de la petite enfance, est « lorsque nous remarquons et valorisons les idées, les réflexions, les questions et les théories des enfants sur le monde, puis recueillons des traces de leur travail (dessins, photographies des enfants en action et transcriptions de leurs mots) à partager avec une communauté plus large"

Ainsi, la documentation est un processus, utilisé pour relier les connaissances et l'apprentissage de l'enfant/des enfants avec les familles, les autres collaborateurs et même les enfants eux-mêmes.

La documentation fait partie intégrante du cycle d'enquête - observer, réfléchir, documenter, partager et répondre.

La documentation pédagogique, en termes de documentation de l'enseignant, est « l'histoire de l'enseignant du mouvement dans la compréhension des enfants ». Selon Stephanie Cox Suarez dans 'Documentation - Transforming our Perspectives', "les enseignants sont considérés comme des chercheurs, et la documentation est un outil de recherche pour soutenir le renforcement des connaissances chez les enfants et les adultes"

La documentation peut prendre de nombreux styles différents dans la salle de classe. Les exemples suivants illustrent les façons dont la documentation peut rendre la « recherche », ou l'apprentissage, visible :

  1. Panneaux de documentation (présentation de type babillard avec plusieurs images et descriptions du projet ou de l'événement).
  2. Journal quotidien (un journal tenu chaque jour qui enregistre le jeu et l'apprentissage en classe)
  3. Documentation développée par ou avec les enfants (lors de l'observation des enfants pendant la documentation, l'objectif de l'observation de l'enfant est utilisé dans la documentation proprement dite)
  4. Portfolios individuels (documentation utilisée pour suivre et mettre en évidence le développement de chaque enfant)
  5. Documentation électronique (utilisation d'applications et d'appareils pour partager la documentation avec les familles et les collaborateurs)
  6. Transcriptions ou enregistrements de conversations (l'utilisation de l'enregistrement dans la documentation peut amener des réflexions plus approfondies à la fois pour l'éducateur et l'enfant)
  7. Histoires d'apprentissage (un récit utilisé pour « décrire l'apprentissage et aider les enfants à se considérer comme des apprenants puissants »)
  8. La salle de classe comme documentation (réflexions et documentation de l'environnement physique d'une salle de classe).

La documentation est certainement un processus en soi, et c'est aussi un processus au sein de l'éducateur. Voici le développement de la documentation au fur et à mesure qu'elle progresse pour et dans l'éducateur lui-même :

  • Développer des habitudes de documentation
  • Devenir à l'aise avec le fait de rendre public le récit des activités
  • Développer des compétences en littératie visuelle
  • Conceptualiser(s) le but de la documentation comme rendre les styles d'apprentissage visibles, et
  • Partagez des théories visibles à des fins d'interprétation et de conception ultérieure du programme d'études.

Voir également


Les références

Liens externes