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?
Répondre
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
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.
- 1. Où puis-je trouver un bon tutoriel pour IJG libjpeg
- 2. Où puis-je trouver un bon code source C++?
- 3. Où puis-je trouver un bon VCS écrit en PHP?
- 4. Où puis-je trouver un bon exemple de documentation?
- 5. Connaissez-vous un bon guide de référence rapide pour un certain nombre de langages de programmation?
- 6. Où puis-je trouver un bon contrôle treeview pour Flex qui supporte les cases à cocher?
- 7. Où puis-je trouver un bon matériel d'introduction pour créer des plugins IE?
- 8. Où puis-je trouver un bon exemple de code pour le jeu iPhone?
- 9. Où puis-je trouver des modèles/diagrammes visio décents pour l'architecture logicielle?
- 10. Où est un bon analyseur d'adresse
- 11. Est-ce que quelqu'un connaît un bon guide pour que Ninject 2 fonctionne dans ASP.NET MVC?
- 12. Où puis-je trouver des instructions SQL pour créer un modèle EAV?
- 13. Objectif-C - Guide pour créer un graphe
- 14. Où puis-je trouver un bon tutoriel/référence HTMLEditorKit, qui explique comment éditer des documents HTML?
- 15. Où puis-je trouver un bon parseur MediaWiki Markup en PHP?
- 16. Où trouver un très bon tutoriel PHP CMS/BLOG avec des objets et des classes?
- 17. Où puis-je trouver un bon exemple de commentaires de documentation C# /// xml en cours d'utilisation?
- 18. Où puis-je trouver un bon exemple d'Open-Flash-Charts et Java?
- 19. Où puis-je trouver un parenthéseur complet pour Haskell?
- 20. Où puis-je trouver un exemple ZwCreateFile pour C++?
- 21. Où trouver un fichier de configuration pour SourceInsight?
- 22. Existe-t-il un guide de l'utilisateur Subversion pour Git?
- 23. Où puis-je trouver un éditeur de diagramme Nassi-Shneiderman?
- 24. Créer un enregistrement où le modèle hérite d'un autre modèle
- 25. Comment écrire un bon standard RFC et par où commencer?
- 26. Quel est un bon moyen d'assigner un objet modèle à un symbole après l'avoir sauvegardé?
- 27. Où puis-je obtenir un bon éditeur de css gratuit?
- 28. Où puis-je trouver un exemple de modèle de jeu de burn-down/planification?
- 29. Existe-t-il un guide TFS pour l'édition de workflow?
- 30. Trouver le bon VPS
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? –
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. –