Aide Logiciel
Ce tutoriel explique comment utiliser TM-Wiki pour gérer l'aide en ligne de vos outils
Sommaire |
Rédaction de l'article d'aide
Titre
Pour faciliter la recherche de l'aide sur votre logiciel, il est important de metter un titre simple et clair. Voici la recommandation :
<votre logiciel>:Aide
Contenu
Il est fortement recommandé de classer les sujets d'aide par fonction et/ou boite de dialogue, car nous verrons par la suite qu'il est possible de réaliser de l'aide contextuelle à partir de votre application vers des sujet d'aide spécifique.
Par ailleurs, les copies d'écran ne sont pas forcément nécessaire, pensez que l'utilisateur a probablement le logiciel sous les yeux au moment où il consulte l'aide.
Wiki
N'ouliez pas que le Wiki est un site communautaire, le plus important est avant tout la structure de votre aide avant son contenu. Donc pensez à lister toutes les fonctionnalités et boites de dialogue qui nécessitent de l'aide avant de commencer à remplir chaque paragraphe. Peut-être d'autres personnes s'occuperont de compléter ce que vous n'avez pas indiqué.
Aide complémentaire
Il est possible d'écrire plusieurs articles, même s'il est préférable de grouper tout dans le même. Si son contenu est trop imposant, trop complexe ou traitant de sujets trop diverses, il est alors préférable de regrouper l'aide en plusieurs sous-articles.
Dans ce cas, utiliser toujours des titres simples, comme dans l'exemple suivant.
<votre logiciel>:Dépannage <votre logiciel>:Skin
Enfin, pensez à bien référencer les articles d'aides complémentaire dans l'article d'aide principal.
Catégorie
Les aides sur les logiciels communautaires sont à placer dans la catégorie des tutoriel divers, alors que l'article sur le logiciel sera, lui, dans la Outils.
Merci de veiller à ce que les articles soient dans le bonnes catégories.
Intégration dans l'application
Liens ancrés dans l'article
Afin d'accéder directement à un paragraphe, il faut mettre des ancres. Le Wiki place automatiquement des ancres dans les titres de chapitre, mais il est préférable de les préciser manuellement pour chaque sujet succeptile d'être accédé directement.
Pour ajouter une ancre sur un chapitre, il suffit d'écrire.
=== <span id="Ancre1">Fonction 1</span> ===
L'ancre peut être accédée directement depuis l'intérieur de la page en intégrant la chaine suivante dans la page
[[#Ancre1]]
Depuis un autre article du wiki en indiquant
[[<votre logiciel>:Aide#Ancre1]]
Accès direct depuis l'application
Après avoir placé les ancres dans votre sujet, vous pouvez accéder à votre article par l'URL
http://fr.tm-wiki.org/wiki/<votre logiciel>:Aide
et directement à une ancre donnée
http://fr.tm-wiki.org/wiki/<votre logiciel>:Aide#Ancre1
L'intérêt des ancres est évident : vous pouvez ajouter dans vos fenêtre des boutons/liens permettant d'afficher directement l'aide sur cette boite en particulier.
Pour ce faire, la solution la plus simple est d'appeler le Shell Windows en exécutant le l'URL. L'association des protocoles dans la base de registre fera que le navigateur sera lancé automatiquement et afficher la page demandée. Votre aide contextuelle s'affiche alors directement.
Gestion des autres langues
Si votre logiciel est multi-langue, il est important de proposer, au moins, une aide en anglais. Si vous avez plusieurs aides, voici des recommandations :
- Gardez la même structure d'article.
- Si les titres des chapitres sont traduits, conservez les même ancres.
- Pensez, comme toujours à lier les deux articles ensemble.
