Searches related to exemple de documentation technique informatique filetype:pdf PDF

Documentation technique

19 janv. 2012 L'utilisation d'un SGDB plus complexe (utilisant par exemple une architecture client/serveur) n'est pas nécessaire. L'application accède à la ...

Rédaction de documents techniques

– TC10 : Documentation technique de produits. – Documentation informatique : – Exemple LaTex impose « deux passages » ... ○ Liste des acronymes. ○ Résumé(s) ...

Le document technique

Le premier exemple (p. 4 à 7) est une section d'un devis d'architecture. Le document a été rédigé par une technologue en vue de la rénovation

DOSSIER JUSTIFICATIF des travaux de R&D déclarés au CIR

29 juin 2018 le site d'un projet par exemple) ou hypertexte (vers un document joint en annexe) et ... Technique prouvée originale. La preuve de sa ...

DOSSIER TECHNIQUE

Documentation technique DWL-G700AP. Page 12. Documentation La téléphonie interne est assurée par un ancien modèle d'autocommutateur téléphonique privé (PABX.

Dossier technique MPLS cg 78 v2.1

Le plan de modernisation envisagé contient un volet relatif aux infrastructures informatiques être administrés à distance depuis le rectorat par exemple. La ...

documentation technique API Actes v1.1

1 févr. 2023 dispositions de la loi n° 78-17 du 6 janvier 1978 modifiée relative à l'informatique aux fichiers et aux libertés. A ce titre

DOCUMENTATION ASSOCIEE A UN PROJET LOGICIEL

31 août 2004 Par exemple il est possible de regrouper en un seul tous les ... Contenu du document. « FICHE DE FAIT TECHNIQUE ». Pour une FFT donnée ...

DOSSIER TECHNIQUE

être mis en place (murs de soutènement par exemple). - La maintenance des dispositifs élévateurs et des différents éléments techniques. CABLAGE INFORMATIQUE.

Monetico Paiement - Documentation Technique

5 juin 2019 par requête informatique et de manière sécurisée les ... Ci-dessous un exemple de document JSON authentification dans le cadre du 3DSecure v2.

Documentation technique

19 janv. 2012 L'utilisation d'un SGDB plus complexe (utilisant par exemple une architecture client/serveur) n'est pas nécessaire. L'application accède à la ...

Le document technique

Le premier exemple (p. 4 à 7) est une section d'un devis d'architecture. Le document a été rédigé par une technologue en vue de la rénovation

DOCUMENTATION ASSOCIEE A UN PROJET LOGICIEL

31 août 2004 Documents techniques. 5. 3.1. Document de spécification des exigences du logiciel. 5. 3.2. Documents des tests de validation du logiciel.

Rédaction technique en informatique

INF 229 ? Rédaction technique en informatique page i version 5.0 – 2009-10-07. Table des matières Figure 11 – Exemples de rapport de documentation.

Documentation Informatique

2 août 2017 MUR (Documentation Informatique). 1. Programme MUR - Manuel informatique de l' ... remplir se reporter à la documentation technique de.

Rédaction de documents techniques

TC10 : Documentation technique de produits. – Documentation informatique : ? ISO/IEC 26513:2009 termes (exemple : package de l'Unité P3).

Référentiel technique des infrastructures informatiques des lycées

2 juin 2017 Documentation initiale. 1.1. 2/06/2017. Laurent Couillaud. Ajout détail fibre optique. Validation du document Version.

Processus de rédaction technique

tecture et du développement informatique. Ce document présente quelques exemples de supports de communication technique leur intérêt marketing

LES DOCUMENTATIONS DES SOLUTIONS INFORMATIQUES

Nous nous intéressons ici à la documentation d'utilisation et la documentation technique permettant l'utilisation et la maintenance de la solution mise en

Documentation technique Orange Partner & Orange Developer

Dans le cadre d'une session GPRS le numéro "voix"

Rédaction de documents techniques - Institut national des

Style de rédaction Documentation technique : – Pas de faute d'orthographe – Phrases simples (facilite la traduction) peu de « qui que » – On n'utilise pas de synonyme/unification des termes (exemple : package de l'Unité P3) – Privilégier le même support (LaTex vs OO) : plus facile pour garantir la cohérence globale

SUPPORT DE COURS DE GENIE LOGICIEL

incontournables pour trouver de la documentation papier : le catalogue de la bibliothèque universitaire d'Avignon le catalogue collectif des universités (SUDOC : http://www sudoc abes fr) le catalogue mondial (Worldcat : http://www worldcat org/) Le catalogue de la Bibliothèque nationale de France (http://catalogue bnf fr)

DOCUMENTATION ASSOCIEE A UN PROJET LOGICIEL

1 FICHE DU DOSSIER DE DOCUMENTATION LOGICIELLE Description Cette fiche répertorie l’ensemble des documents associés au logiciel elle constitue le point d’entrée de la documentation Contenu du document : voir en annexe 2 DOCUMENTS D’ORGANISATION Objectif

GUIDE DES BONNES PRATIQUES DE L’INFORMATIQUE

riser votre usage de l’informatique Chaque règle ou « bonne pratique » est accompa - gnée d’un exemple inspiré de faits réels auxquels l’ANSSI a été confrontée Les mots en italique marqués d’un * sont expliqués dans le glossaire situé à la fin de ce guide

Le document technique - CCDMD

Le premier exemple (p 4 à 7) est une section d’un devis d’architecture Le document a été rédigé par une technologue en vue de la rénovation d’un centre communautaire puis a été vérifié et signé par l’architecte responsable du projet Il est conforme au Devis directeur national (DDN)* qui expose

Searches related to exemple de documentation technique informatique filetype:pdf

—Création de la documentation par des équipes dédiées —Utilisation cohérente de formats structurés Les formats non adaptés à la rédaction technique sont par exemple les formats de traitement de texte qui ne dissocient pas suf?samment la mise en page du contenu

Quel est le rôle de la documentation technique?

technique : « développeurs, intégrateurs, responsables techniques, éventuellement chefs de projet ». Dans le cadre d'une relation maîtrise d'ouvrage ou maîtrise d'œuvre pour réaliser un logiciel, la responsabilité de la documentation technique est à la

Quels sont les différents types de techniques de la documentation?

Les techniques de la documentation, c’est l’organisation de documents sur tous les types de supports et l’organisation de l’information en tout genre. Tu œuvres dans ce domaine en t’occupant de l’acquisition, du traitement, de la classification, de l’indexation, de la description, de la diffusion et de la préservation de documents et de données.

Quelle est la forme de la documentation ?

La forme de la documentation est secondaire. L'important est que tout y est décrit. Cela commence par la conception, en incluant les différentes variantes et leur évaluation. Cette dernière est suivie par la description du code sans oublier la description compréhensible des tests.

Quels sont les avantages de la documentation technique?

?Documentation technique : –Pas de faute d'orthographe –Phrases simples (facilite la traduction), peu de « qui, que, ... –On n'utilise pas de synonyme/unification des termes (exemple : package de l'Unité P3) –Privilégier le même support (LaTex vs. OO) : plus facile pour garantir la cohérence globale

Processus de rédaction technique

Version 1.5

carrereo@gmail.com

©2011- 2015 Olivier Carrère

www.redaction-technique.org Publié sous licence Creative Commons BY-NC-SA 4.0

Table des matières

1 Documentation technique : diminuer les coûts, améliorer la satisfaction client

1.1 De la rédaction à la communication technique

1.2 Les trois niveaux de la documentation technique

1.3 Principe de simplicité KISS

1.4 Formats et outils

2 Rédaction technique : un processus industriel

2.1 Définition du projet

2.2 Collecte de l"information

2.3 Création du contenu

2.4 Format source

2.5 Référentiel

2.6 Validation et contrôle qualité

2.7 Traduction

2.8 Format cible

2.9 Livraison

3 Format structuré DITA XML21

3.1 Cas concrets d"utilisation de DITA XML

3.2 Formats structurés et non structurés

3.3 Une architecture documentaire trop complexe?

3.4 Du document à la base documentaire modulaire

3.5 Cas concret : documentation de NuFirewall

4 Le coin dugeek42

4.1 Le Raspberry Pi 3 en tant que plateforme de documentation

4.2 sed : modifiez votre texte sans ouvrir vos fichiers

4.3 Expressions régulières en Python

4.4 Didacticiels DITA XML et XSL-FO

5 Contact60

Chapitre 1. Documentation technique : diminuer les coûts, améliorer la satisfaction client 1.

Documentation tec hnique: dimin uer

les coûts, améliorer la satisfaction client

La documentation technique, c"est comme une ampoule : une ampoule basse consommation demande un investissement

plus important en début de cycle de vie, mais a rapidement un coût plus faible.

Comme une ampoule basse consommation, un processus de rédaction technique industriel diminue les coûts. Il réduit

également letime to market. À coût initial légèrement supérieur ou égal, il améliore également la qualité.

Coût moindre

moins de v olumeà créer suppression des mises à jour répétiti ves moins de v olumeà traduire

Time to marketréduit

réutilisation maximale du contenu risque zéro de perte de données

Qualité améliorée

briques d"information f acilementoptimisables cohérence parf aitedu contenu d"entreprise

Une documentation industrielle repose sur :

un format documentaire modulaire, un format de rédaction structurée, une chaîne de production et de publication documentaire fiable.

Si la chaîne de création et de publication choisie repose sur des logicielsopen-source, le coût de mise en place et d"appren-

tissage peut même être compensé par l"économie sur les licences de logiciels. En tout état de cause, de trop nombreuses

sociétés de haute technologie ont industrialisé leurs processus métier, mais laissent en friche la création, la gestion et la

publication de leur contenu d"entreprise. Les coûts cachés (rédaction par des ingénieurs et non par un rédacteur technique

compétent, mauvaise exploitation du capital immatériel, diminution de la satisfaction client, augmentation des coûts de

support, etc.) peuvent être considérables. Pourtant, les solutions et les compétences existent.

De la rédaction à la communication technique

Le but de la communication technique est de transformer les prospects en clients satisfaits. Le rédacteur technique fournit

au marché l"information dont il a besoin pour sélectionner, évaluer et utiliser une solution de haute technologie. Au sein

de l"entreprise, il est l"interface entre les services R&D et marketing. À l"extérieur, il crée le dialogue entre l"entreprise et

ses différents publics.

La communication technique est souvent réduite à la rédaction technique. La rédaction technique est destinée à fournir

la documentation des produits, et intervient en aval de la vente. La communication technique intervient dès l"amont du

processus de vente et accompagne le produit tout au long de son cycle de vie. Destinée autant au grand public, aux

journalistes et aux prospects qu"aux clients, elle dépasse et englobe la rédaction technique, destinée uniquement aux

utilisateurs. carrereo@gmail.com

Processus de rédaction technique

Chapitre 1. Documentation technique : diminuer les coûts, améliorer la satisfaction clientAnimation

Magazine

d"entreprise

Site web

Plaquette

Guide de

l"utilisateur Livre blanc

Niveau technique

Valeur marketingFig. 1.1 -Supports de rédaction marketing et technique

La communication technique a pour but de montrer l"adéquation d"un produit aux besoins de sa cible. Elle recourt pour

cela à différents supports, plus ou moins adaptés au niveau d"expertise de son public et à son statut par rapport à l"entre-

prise (grand public, journalistes, prospects, clients...). Le rédacteur technique doit adapter son message à chaque public.

Utilisant toutes lesressources de la communication (rédaction, illustrations,films, animations...) il prend constamment en

compte la dimension marketing. Pour augmenter les ventes, tout support de communication doit être un outil marketing.

Mais peut-on être à la fois logique et créatif? C"est nécessaire dans les domaines de la composition musicale, de l"archi-

tecture et du développement informatique. C"est également le cas pour un rédacteur technique.

Ceci nécessite :

une étude de l"adéquation entre les besoins du public et les mo yensde l"entreprise, une bonne capacité de création et de rédaction, une gestion de projet rigoureuse, un processus industriel de production et de v alorisationdu contenu. au public et les modalités de leur valorisation.

Valoriser un contenu signifie :

produire un contenu de qualité adapté à sa cible, conserv ertout le contenu e xistant,dans ses dif férentesv ersions, réutiliser ou rec yclerà bon escient le contenu e xistant.

Les trois niveaux de la documentation technique

Si l"on compare la documentation technique à un jardin, on peut la classifier selon les niveaux suivants :

Friche

P asd"utilisation de processus documentaire.

Création de la documentation par des équipes non dédiées. Utilisation de formats non adaptés ou utilisation incohérente de formats adaptés.

Jardin à l"anglaise

Utilisation de processus documentaires fiables.

Création de la documentation par des équipes dédiées. Utilisation cohérente de formats adaptés, mais non structurés.

Jardin à la française

Utilisation de processus documentaires fiables.

Création de la documentation par des équipes dédiées. Utilisation cohérente de formats structurés.

Les formats non adaptés à la rédaction technique sont par exemple les formats de traitement de texte, qui ne dissocient

pas suffisamment la mise en page du contenu.

Les formats adaptés sont les formats de type FrameMaker, qui dissocient (relativement) la mise en page du contenu, mais

ne sont pas sémantiques. carrereo@gmail.com

Processus de rédaction technique

2 Chapitre 1. Documentation technique : diminuer les coûts, améliorer la satisfaction client

LesformatsstructuréssontlesformatssémantiquesdetypeDocBookou DITA (DarwinInformationTypingArchitecture)

XML.

Le stade du jardin à l"anglaise est déjà très satisfaisant et garantit qu"une information de qualité est fournie à l"utilisateur.

Celui du jardin à la française permet en outre à l"entreprise de mieux maîtriser son contenu et de réduire les coûts de

production.

À elle seule, la présence d"une des trois composantes (processus, équipe dédiée et format adapté) ne peut garantir un

résultat satisfaisant. Confiez par exemple des outils permettant de générer du contenu au format DITA XML à des colla-

borateurs dont la communication technique n"est pas le métier ou sans mettre en place de processus de gestion du cycle

de vie de la documentation technique, et vous obtiendrez des résultats décevants. Seule la présence conjointe de ces trois

éléments fournira un résultat optimal.

Un index est-il utile dans un PDF?

À l"heure des documents dématérialisés, un index est-il un élément indispensable d"une bonne documentation technique?

La recherche en plein texte semble avoir détrôné l"index. Les notices techniques ne sont plus qu"exceptionnellement

fournies aux clients sous forme papier. Ce drôle d"objet qu"est le PDF, format d"échange entre un format source non

destiné aux clients et une version imprimée qui ne l"est que de manière marginale, est entré dans les moeurs. La séquence

de touchesCtrl+Fest un réflexe plus naturel aujourd"hui pour qui recherche une information.

Un texte destiné au Web recourra à une grande dispersion terminologique pour accroître sa visibilité sur les moteurs de

recherche. L"emploi des synonymes est de rigueur pour donner au lecteur potentiel plusieurs chemins d"accès à la source

d"information qui peut l"intéresser. Les moteurs de recherche ont rendu l"index caduc.

Si la documentation technique utilise une terminologie cohérente, l"efficacité de la recherche en plein texte est réduite : si

le rédacteur technique a utilisé uniquement le termerépertoire, le lecteur qui recherche le motdossierpassera à côté de

l"information qu"il recherche.

L"index, s"il est bien réalisé, a alors toute son utilité. Seul problème : créer un bon index demande un effort important en

toute fin de projet, juste avant l"heure de la livraison. Et fournir un mauvais index n"a aucun intérêt ni pour le client, ni

pour l"entreprise.

Un index est donc paradoxalement plus utile pour une bonne documentation que pour une mauvaise (du moins, une docu-

mentation dont la terminologie n"est pas cohérente). Mais son rapport coût/utilité est faible. C"est un luxe que l"entreprise

peut rarement s"offrir, mais certainement pas le premier aspect qualitatif qu"il faut améliorer. Un index est la cerise sur le

gâteau d"une documentation technique - le plus important reste le gâteau.

Principe de simplicité KISS

Le principe KISS (Keep it simple stupid), n"est pas spécifique à la rédaction technique. Il s"agit d"un principe général

d"ingénierie, qui postule que tout objet matériel ou virtuel construit par l"homme est plus fiable et plus facile à maintenir

et à faire évoluer si sa complexité est volontairement réduite. C"est le principe mis en exergue par antiphrase par les

Shadocks :Pourquoi faire simple quand on peut faire compliqué?

C"est ce principe qui a prévalu à la conception des montresSwatch, dont le cahier des charges stipulait qu"elles devaient

embarquer deux fois moins de pièces que leurs consoeurs. Résultat : des montres moins chères, plus fiables et disponibles

en versions sans cesse renouvelées.

Ce qui a spectaculairement fonctionné pour des montres peut être appliqué avec le même succès à la documentation

technique.Quelquesoitleformatutilisé

architecturé, qu"une usine à gaz. Avec DITA XML, il lui suffit de ne pas centraliser lesconrefou de les imbriquer

exagérément. Sous FrameMaker, c"est encore plus simple, peu de garde-fous étant posés : la multiplication des styles et

desoverridespeut rapidement rendre ingérable n"importe quel document.

De même, dans la formulation de ses phrases, le rédacteur technique doit toujours avoir le principe KISS à l"esprit. Il

est facile de construire des phrases alambiquées qui dénotent plus une mécompréhension du sujet qu"un raffinement de

l"écriturequotesdbs_dbs4.pdfusesText_7

[PDF] Searches related to exemple de documentation technique informatique filetype:pdf

Quel est le rôle de la documentation technique?

Quels sont les différents types de techniques de la documentation?

Quelle est la forme de la documentation ?

Quels sont les avantages de la documentation technique?

Processus de rédaction technique

Version 1.5

©2011- 2015 Olivier Carrère

Table des matières

1 Documentation technique : diminuer les coûts, améliorer la satisfaction client

1.1 De la rédaction à la communication technique

1.2 Les trois niveaux de la documentation technique

1.3 Principe de simplicité KISS

1.4 Formats et outils

2 Rédaction technique : un processus industriel

2.1 Définition du projet

2.2 Collecte de l"information

2.3 Création du contenu

2.4 Format source

2.5 Référentiel

2.6 Validation et contrôle qualité

2.7 Traduction

2.8 Format cible

2.9 Livraison

3 Format structuré DITA XML21

3.1 Cas concrets d"utilisation de DITA XML

3.2 Formats structurés et non structurés

3.3 Une architecture documentaire trop complexe?

3.4 Du document à la base documentaire modulaire

3.5 Cas concret : documentation de NuFirewall

4 Le coin dugeek42

4.1 Le Raspberry Pi 3 en tant que plateforme de documentation

4.2 sed : modifiez votre texte sans ouvrir vos fichiers

4.3 Expressions régulières en Python

4.4 Didacticiels DITA XML et XSL-FO

5 Contact60

Documentation tec hnique: dimin uer

Coût moindre

Time to marketréduit

Qualité améliorée

Une documentation industrielle repose sur :

Processus de rédaction technique

Magazine

Site web

Plaquette

Guide de

Niveau technique

Ceci nécessite :

Valoriser un contenu signifie :

Les trois niveaux de la documentation technique

Friche

P asd"utilisation de processus documentaire.

Jardin à l"anglaise

Utilisation de processus documentaires fiables.

Jardin à la française

Utilisation de processus documentaires fiables.

Processus de rédaction technique

éléments fournira un résultat optimal.

Un index est-il utile dans un PDF?

Principe de simplicité KISS