Software Product Documentation




 

Le logiciel idéal serait libre d'erreurs et si facile à utiliser que tout le monde devrait être familier avec elle, la minute où ils démarrer l'application. Toutefois, ce n'est pas le cas dans la vie réelle.

Outre la qualité du produit logiciel, il ya autre chose qui fait la richesse de la transaction: un support technique. En effet, plus les éditeurs de logiciels de soutien et fournir des auteurs de sharewares, plus les utilisateurs sont susceptibles d'acheter le produit.


Support technique pour les produits logiciels peuvent être fournis de plusieurs façons:

  • produit de la documentation en ligne
  • e-mail d'assistance
  • l'accès au soutien des forums mis à jour par les éditeurs de logiciels
  • bases de connaissances.

Une bonne documentation mai exclure dans de nombreux cas, la nécessité d'autres formes de soutien technique. Il n'est cependant pas facile à écrire. L'une des raisons pour lesquelles cela se produit, c'est qu'il est difficile pour les auteurs de shareware ou d'autres concepteurs de logiciels à se mettre dans la peau des utilisateurs, car ils sont déjà très familier avec l'application.

Fichier Lisez-moi

La première chose que tous les produits logiciels devraient avoir est un format de texte "Lisez-moi" qui comprend les éléments suivants:

  • Nom du produit et sa version
  • La date d'expédition
  • Nom de l'entreprise et Auteur
  • Description (comme "gestionnaire de photos")
  • Quoi de neuf A la liste (ce devrait être une liste de correctifs et nouvelles fonctionnalités)
  • Configuration requise (matériel comme processeur, mémoire vive, espace disque, systèmes d'exploitation pris en charge)
  • Prix, options de paiement et les instructions
  • Droit d'auteur et diffusion de l'information (règles pour les personnes qui souhaitent distribuer votre produit)
  • Les coordonnées (courriel, téléphone, site Internet de télécopieur, adresse postale)

Le "Read Me" file est important car tout le monde qui pourraient être intéressés par votre produit est-il s'attendait, y compris les commentateurs, les utilisateurs, ou des gens qui veulent mettre votre produit sur un CD pour la distribution avec un magazine ou sur leur site. L'idée ici est de minimiser la frustration associée à l'information étant trop difficiles à trouver, par conséquent, vous devriez mettre tous au même endroit.

Le manuel

Les auteurs de sharewares autre chose et les éditeurs de logiciels ont besoin de communiquer, avec leur produit est le manuel. La première chose que vous devriez réfléchir au moment où il commence à écrire, c'est la façon dont vos utilisateurs vont l'utiliser. Rares sont celles qui vont la peine de lire tout cela avant de tenter d'utiliser votre produit. Ils sont plus susceptibles de s'adresser à plus tard, quand ils essaient de faire quelque chose et n'arrive pas à comprendre comment le faire, ou quand ils trouvent quelque chose qu'ils ne comprennent pas.

Pour les aider, il est préférable d'organiser vos documents par les tâches. "Comment ..." ne sont plus utiles que simplement documenter chaque commande dans l'ordre. Les explications sont plus faciles à comprendre si elles sont étayées par des tableaux et des diagrammes, autant que possible. Il devrait également être un chapitre intitulé «Dépannage», qui fournit des réponses aux problèmes les plus communs. Au début, vous devez deviner où ces problèmes se produisent mai, mais quelques mises à niveau votre produit plus tard, les réactions des gens qui ont essayé le produit que vous dira quels sont les problèmes les plus courants sont.
Le manuel doit être décomposé en chapitres, dont le premier a dire ce que les autres chapitres contiennent, afin que les gens pourraient facilement trouver ce dont ils ont besoin.

L'interface

Un autre point en mentionnant la valeur est l'interface. Convivial ne suffit pas, l'interface doit être navigatable même si l'utilisateur ne possède pas une compréhension globale de système, de sorte écrans doivent être auto-descriptif.

L'aide en ligne ou la documentation en ligne

De l'aide est également accessible en ligne ou la documentation en ligne. Les documents mis sur le site Web pour les utilisateurs de lire doit figurer dans les résultats de recherche. Elle doit être organisée de telle manière que les utilisateurs, qui ne manqueront pas de se poser des questions comme «Comment puis-je ...» ou «Pourquoi ne puis-je ..." pouvez trouver les réponses rapidement. Beaucoup d'exemples montrant comment effectuer des tâches diverses avec les produits logiciels sont également nécessaires. Une bonne idée est d'inclure des liens vers un glossaire de termes qui pourraient être plus difficiles à comprendre.

Toujours garder à l'esprit que toute personne ayant eu une mauvaise expérience avec un produit tend à s'en souvenir pendant longtemps et le logiciel n'est pas différente. C'est pourquoi vous devriez vous efforcer de faire en utilisant votre produit aussi lisse que possible, une expérience, un soutien quelque chose de bon et de documentation peut vous aider à réaliser.

 
Sans fil au milieu de travailInformation Overload - Arrêter le BarrageLe passé plutôt récente des ordinateursOlder Film Technology Permet HD Remastering de rediffusions VieuxWholesale Computer Parts - Getting Good DealsImportance de l'évolution de la technologie dans l'informatique professionnelleImprimantes jet d'encreLED DisplaysComment faire pour capturer page Web pour l'édition de logiciels utilisant l'impressionElectric Projector ScreensMéthodes de développement: Top-Down et Bottom-Up MethodComment choisir un projecteurOnline Data StoragePlanification d'une sauvegarde et restauration des fichiers For Disaster RecoveryCoût pour la maintenance des PC efficace avec les Power PC Suite 2.0Comment nettoyer votre moniteurEcouter 4:3 Ppt Sur écran 16:9 sans distorsionKnowledge Management SoftwareManufacturing Productivity - ERP & Shop Floor GUI TimeclockGadgets de prendre avec vous en vacances - Pour le confort et le divertissement

© 2007-2012 Geocitoyen.com