2008-10-20 4 views
1

Vous cherchez des liens vers des ressources qui me aideront à rédiger un guide d'utilisateur pour une application logicielle. Je suis à la recherche de quelque chose qui m'aidera à structurer mon guide, à lui donner un style d'écriture approprié, et à faire en sorte qu'il ait un excellent aspect tout au long de l'année.Où puis-je trouver un bon modèle pour un guide d'utilisation d'application logicielle?

+0

Une indication de votre base d'utilisateurs peut vous aider. Cela pourrait-il être n'importe qui, ou sont-ils susceptibles d'être des développeurs/techniquement intéressés? –

+0

Une indication du type de logiciel que vous écrivez aiderait. Si votre logiciel, par exemple, ressemble à Microsoft Word, il vous sera alors facile de proposer un modèle de guide d'utilisateur. –

Répondre

2

Ce lien a quelques points forts. Chaque point est présenté avec un discours clair et avec des justifications en ligne.

Lors de la rédaction des procédures, utilisez la voix active (par exemple accéder) et utilisateurs d'adresses directement (écrire « vous » plutôt que « l'utilisateur »).

En expliquant une action, utilisez la "commande" forme du verbe:

"Choisissez une option dans le menu et appuyez sur [ENTRER]."

http://www.klariti.com/technical-writing/User-Guides-Tutorial.shtml

Voici la liste complète des sujets abordés dans l'article ci-dessus:

  • Front Page (pages de couverture)
  • couverture et Page titre
  • Avertissement
  • Préface
  • Sommaire
  • corps du guide
  • Procédures
  • procédures d'écriture
  • texte Chunking
  • Nombre vos étapes
  • Utilisation du If-Then Approche
  • Documents de référence
  • Retour matière
  • Glossaire
  • I ndex
  • établissement de normes
  • Document Format
  • Structure style
  • Langue technique
  • Aborder l'utilisateur
  • Présenter votre matériel
  • Exigences spéciales
0

Pour structure et regarder + se sentir , pensez à utiliser un framework tel que DocBook.

DocBook utilise un schéma de balisage XML qui vous fait penser à la façon dont votre document devrait être organisé. Il y a des transformations XSL pour le convertir en formats courants comme HTML et PDF avec une charge complète d'options de configuration pour le faire paraître comme vous le souhaitez. Et c'est open-source (gratuit). Il y a des inconvénients bien sûr: le schéma est assez gros, et l'édition peut être un travail difficile sans un bon éditeur XML.

Exemples: http://wiki.docbook.org/topic/WhoUsesDocBook

Questions connexes