Types de documentation
L'équipe de développement des supports pédagogiques de Macromedia souhaite pouvoir créer la meilleure documentation possible pour vous aider à mieux profiter de nos produits. C'est une des raisons pour lesquelles nous proposons plusieurs formats de documentation, par exemple.
Modes d'emploi
La documentation a été scindée en plusieurs manuels avec différents types d'informations prévues pour différents groupes d'utilisateurs. Les produits peuvent être accompagnés des types de manuels suivants :
| Type de manuel | Contenus | Niveau utilisateur |
|---|---|---|
Bien démarrer avec <nom du produit> |
Vue d'ensemble, didacticiels | Débutant |
Utilisation de <nom du produit> |
Processus, procédures, vues d'ensemble, concepts | Débutant, intermédiaire |
| Installation, configuration et administration de <nom du produit> | Généralement associés à des serveurs et conçus pour les administrateurs | Intermédiaire |
| Référence de langage et API | Référence et exemples d'utilisation des interfaces de programmation | Intermédiaire, avancé |
Extension de <nom du produit> |
Interface API permettant d'ajouter des fonctionnalités à un produit | Avancé |
| Aide-mémoire <nom du produit> | Présentation de l'interface utilisateur, instructions d'installation | Débutant, intermédiaire |
LiveDocs
LiveDocs est un système en ligne conçu pour recueillir des commentaires sur la documentation. Les commentaires apparaissent en bas de chaque page et un bouton permet à l'utilisateur d'ajouter ses propres commentaires.
LiveDocs est disponible pour tous les produits. Certains produits sont même accompagnés d'une version traduite de LiveDocs. La documentation LiveDocs peut être obtenue pour les divers produits sur la page LiveDocs* ou à partir de n'importe quelle page de notre système d'aide.
Remarque – La publication de commentaires est réservée aux titulaires d'un compte macromedia.com. L'adhésion ne prend que quelques instants et est gratuite.
Aide en ligne
L'aide en ligne d'un produit comprend des informations sur les concepts et les procédures permettant d'accomplir certaines tâches, et des informations de référence pour les langages de programmation. Tous les manuels disponibles pour un produit font également partie de son système d'aide.
Tous les systèmes d'aide comprennent des index et des outils de recherche. Vous pouvez accéder au système d'aide d'un produit à partir du menu Aide. Vous pouvez également afficher de l'aide contextuelle (dans une boîte de dialogue ou pour une autre commande) en cliquant sur l'icône d'aide correspondante.
Tous les manuels sont disponibles au format PDF et peuvent être consultés hors ligne ou imprimés. Les informations présentées dans les fichiers PDF sont identiques à celles du système d'aide et de LiveDocs. Pour certains produits, tous les manuels sont combinés au sein d'un même fichier PDF.
Didacticiels
La plupart des produits sont accompagnés de didacticiels détaillés. Certains didacticiels se trouvent dans le système d'aide ou sont publiés sur le centre des ressources Documentation de macromedia.com. Par exemple, de nombreux didacticiels pour Flash 8 se trouvent sur le centre des ressources Documentation.
Exemples
Certains de nos produits destinés aux développeurs sont accompagnés d'exemples illustrant les meilleures pratiques et les types de fichiers qui peuvent être créés. Les exemples sont publiés dans le menu Aide du produit, sur le CD du produit ou sur le centre des développeurs.
Contenus traduits
La plupart des manuels, des didacticiels et des matériaux pédagogiques sont traduits dans plusieurs langues. Ceux qui utilisent une version traduite d'un produit Macromedia peuvent accéder au système d'aide dans la même langue à partir du menu Aide. Vous pouvez également consulter le centre des ressources Documentation sur macromedia.com et sélectionner la langue de votre choix dans le menu Documentation, par langue.
