Recherche d'outils de documentation conformes aux normes

Question

Lorsque j'essaie de documenter les étapes de configuration de mon serveur dans mon blog, il ne semble pas structuré. J'ai besoin d'une sorte de guide de mise en page de normes, quelque chose orienté vers howtos, avec des en-têtes, des étapes, des standards de création de documentation supportés par un wiki et pouvant appliquer ou guider la mise en page du document.

Existe-t-il de telles normes de documentation accompagnées d'un jeu d'outils wiki?

Answer 1

donner un essai à DocBook

Answer 2

Je lis normes conformes comme une simple « organisée », ou « évident pour le lecteur ». Considérez les moyens typiques user documentation est généralement organisé. Vous allez généralement ouvrir la documentation dans 3 cas d'utilisation différents:

1. Le système est nouveau et vous essayez de comprendre ce qui se passe. (PDF, articles plus longs)
2. Vous recherchez les détails de quelque chose que vous avez oublié. (Index des informations de référence de style homme)
3. Vous avez besoin d'aide pour un problème spécifique et vous ne savez pas exactement comment cet outil vous aide. (Recettes, FAQs)

Je tenterais probablement de copier un écosystème particulier (Windows, Unix, Apple), basé sur ce que les utilisateurs sont les plus familiers.