Documentation produit logiciel

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

Outre la qualité du produit logiciel, il ya autre chose qui fait la richesse de l'affaire: le support technique. Plus les éditeurs de logiciels de soutien et les auteurs de shareware fournir, plus les utilisateurs sont susceptibles d'acheter le produit.

Support technique pour les produits logiciels peut être fournie de plusieurs façons:
documentation produit en ligne
e-mail d'assistance
accéder à soutenir des forums tenus par les éditeurs de logiciels
bases de connaissances.


Une bonne documentation peut exclure dans de nombreux cas la nécessité d'autres formes de soutien technique. Il est, cependant, pas facile à écrire. L'une des raisons pour lesquelles cela arrive, c'est qu'il est difficile pour les auteurs de shareware ou d'autres développeurs de logiciels de se mettre dans la peau de l'utilisateur, car ils sont déjà complètement familiarisé avec l'application.

Fichier Lisez-moi

La première chose que tout produit logiciel doit avoir un format de texte "Lisez-moi" qui comprend les éléments suivants:
Nom du produit et la version
Date d'expédition
Société et Nom de l'auteur
Description (comme "organisateur de photo")
Un Quoi de Nouvelle liste (ce doit être une liste de correctifs et de nouvelles fonctionnalités)
Configuration requise (matériel, comme l'espace disque CPU, RAM,, les systèmes d'exploitation pris en charge)
Le prix des options de paiement et les instructions
Droits d'auteur et de distribution (règles pour les gens qui veulent distribuer votre produit)
Coordonnées (email, téléphone fax site web et adresse postale)


Le "Lisez-moi" est important car tout le monde qui pourrait être intéressé par votre produit est-il s'attendait, y compris les examinateurs, les utilisateurs ou les gens qui veulent mettre votre produit sur un CD pour la distribution d'un magazine ou sur leur site internet. L'idée ici est de minimiser la frustration associée à l'information étant trop difficile à trouver, donc vous devriez mettre le tout dans un seul endroit.

Le Manuel

L'autre chose que les auteurs de shareware et éditeurs de logiciels doivent fournir avec leur produit est le manuel. La première chose que vous devriez penser à quand on commence à écrire est de savoir comment vos utilisateurs vont l'utiliser. Rares sont ceux qui la peine de lire tout cela avant d'essayer d'utiliser votre produit. Ils sont plus susceptibles de se tourner vers lui plus tard, quand ils essaient de faire quelque chose et ne peux 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 votre documentation par des tâches. "Comment ..." sections sont plus utiles que de simplement documenter toutes les commandes dans l'ordre. Les explications sont faciles à comprendre si elles sont appuyées par des photos et des diagrammes, chaque fois que possible. Il devrait également y avoir un chapitre intitulé "Dépannage", qui fournit des réponses aux problèmes les plus courants. Au début, vous devrez deviner où ces problèmes peuvent se produire, mais un couple de la mise à niveau de votre produit plus tard, les réactions des gens qui ont essayé le produit vous dira quels sont les problèmes les plus courants sont.
Le manuel doit être décomposé en chapitres, dont le premier dire ce que les autres chapitres contiennent, de sorte que les gens puissent facilement trouver ce dont ils ont besoin.

L'interface

Un autre point intéressant est en mentionnant l'interface. Convivial ne suffit pas, l'interface doit être navigable même si l'utilisateur n'a pas une compréhension globale des systèmes, de sorte que les écrans doivent être auto-descriptif.

L'aide en ligne ou à la documentation en ligne

Il ya aussi l'aide en ligne ou la documentation en ligne. La documentation sur le site web pour les utilisateurs de lire doit apparaître 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 pouvez I. .." ou "Pourquoi ne pas I. .." peut trouver les réponses rapidement. Beaucoup d'exemples montrant comment effectuer des tâches diverses avec le logiciel sont également nécessaires. Une bonne idée est d'inclure des liens vers un glossaire des termes qui pourraient être plus difficiles à comprendre.

Toujours garder à l'esprit que toute personne qui a eu une mauvaise expérience avec un produit tend à s'en souvenir pendant longtemps et le logiciel n'est pas différent. C'est pourquoi vous devriez vous efforcer de rendre l'utilisation de votre produit aussi lisse que possible une expérience, quelque chose de support et la documentation peuvent vous aider à atteindre....