Introduction sur la façon de contribuer |
Une bonne documentation est à la fois une affaire de contenu et de structure. Le contenu doit être aussi pédagogique que possible pour le groupe de lecteurs ciblés. Pour ce faire, vous devez illustrer votre propos d'exemples et de captures d'écran chaque fois que possible. Même si le but ici n'est pas forcément de fournir une documentation exhaustive, elle doit être relativement stable. Il faut donc que vous vérifiiez les fautes d'orthographe de votre texte avant de le soumettre. Les textes en devenir doivent être déposés dans le répertoire incoming ou sur TeXmacs Wiki.
Il est également extrêmement important que vous structuriez votre document le plus possible en utilisant le marquage spécial du fichier de style tmdoc. Ce marquage peut être utilisé pour compiler automatiquement des livres destinés à l'impression, permettre différents styles d'affichage et faciliter la recherche d'informations dans la documentation. Vous devez toujours fournir les informations relatives aux droits d'auteurs et licence de documentation et indiquer comment naviguer dans vos documents, surtout s'ils sont nombreux.