Exemple de guide d`utilisation d`un logiciel

Posted by in Uncategorized

La documentation ne s`écrit pas-mais il est maintenant possible de l`écrire sans avoir à lutter avec la mauvaise forme, ou la portée floue ou le doute sur ce qui devrait être inclus ou quel style à adopter. En cliquant sur le sujet particulier, l`utilisateur sera redirigé vers la page que l`on doit faire référence. Voici un exemple de l`intégration de ScreenSteps avec Salesforce. Il peut même-dans une certaine mesure-être généré automatiquement, mais ce n`est jamais suffisant de son propre chef. Vous relâchez le code, et les gnomes de code viennent et le rendre meilleur pour vous. Ils semblent être un secret, mais ils ne devraient pas être. Chaque manuel de SwipeGuide suit ce même format de base. Il n`a pas d`importance à quel point votre logiciel est bon, parce que si la documentation n`est pas assez bon, les gens ne l`utiliseront pas. De plus, il a une fonction de recherche de mots clés afin que les utilisateurs finaux peuvent taper dans leur question et rechercher votre documentation ScreenSteps pour une réponse. La plupart des documents d`exigences comprendront une liste des caractéristiques générales du produit ainsi que le comportement du système détaillé nécessaire pour fournir ces fonctionnalités. Tu dois y mettre du travail.

Grâce aux choses que l`enfant fait, il apprendra des choses importantes sur la cuisine. Montrez un exemple révélateur de ce à quoi votre projet serait normalement utilisé. L`apprenant a besoin de voir que les actions que vous lui demandez de prendre ont l`effet que vous dites qu`ils auront. L`un des maux de tête les plus importants que les mainteneurs de documentation doivent traiter n`est pas d`avoir une image claire de ce qu`ils devraient faire. Historiquement, il existait des versions logicielles distinctes pour thermo-Calc et les kits de développement logiciel (SDK). Comment faire pour commencer, “” comment remplacer une pièce, “et” Comment nettoyer votre appareil “sont tous des exemples de sujets dans le Guide de l`utilisateur ci-dessus. Félicitations d`avoir peur! Ce genre de choses pourrait ne pas vous importe, mais les gens qui veulent utiliser votre code se soucient de tout un tas. Par exemple, sa conception de tutoriels a une base pédagogique; il pose un tuteur et un apprenant, et considère l`utilisation de logiciels comme un métier dans lequel la compréhension abstraite des principes généraux découle des étapes concrètes qui traitent des détails. Un plan d`itération définit les activités qui seront exécutées au cours d`une itération.

La chose importante est que, après avoir fait le tutoriel, l`apprenant est en mesure de donner un sens au reste de la documentation, et le logiciel lui-même. Ils représentent quatre buts ou fonctions différents, et requièrent quatre approches différentes pour leur création.