Outil de documentation en ligne, où je crée des «objets texte» réutilisables

David

Outil de documentation en ligne, où je crée des «objets texte» réutilisables


Je suis sur le point de commencer à écrire beaucoup de documentation. Pendant que j’écris, je me retrouve à répéter des choses que j’ai déjà écrites dans d’autres parties de la documentation. Je veux par exemple écrire un guide « Mise en route ». Ici, il devrait y avoir des explications de base sur les principales fonctionnalités de l’interface. Dans un autre document, je veux écrire sur la façon de collaborer efficacement en utilisant nos outils. Dans ce document, j’ai également besoin des mêmes explications de base de nos principales interfaces au cas où le lecteur ne les connaît pas toutes. Je voudrais le faire en incorporant un objet « explication de base », qui devrait être réutilisé dans les deux documents, donc une fois mis à jour, les deux documents sont mis à jour. Je sais que je pourrais faire tout cela avec des liens, mais cela rend l’expérience de lecture très confuse car je voudrais rendre les objets texte très petits afin qu’ils puissent être réutilisés massivement.

Quels outils d’édition collaborative en ligne peuvent prendre en charge une telle édition? Mon éditeur préféré est Google Docs, mais je suis ouvert à tout. Google Docs ne prend pas en charge l’intégration.

Zachary Vance

Je ne connais pas de logiciel à recommander, mais la fonctionnalité que vous voulez s’appelle le texte «transclusion».

Zachary Vance

Si vous êtes vraiment techniquement averti, vous pouvez essayer d’installer MediaWiki, mais je ne considère pas cela comme une vraie recommandation.

David

@ZacharyVance Cela aide vraiment beaucoup d’avoir un tel mot de recherche à l’ère de Google. Je vous remercie!

Réponses


 Dave Jarvis

Atlassian’s Confluence propose des extraits , qui est une fonctionnalité de transclusion basée sur ses macros .

Il y a une discussion sur la façon d’ intégrer Confluence à l’outil en ligne d’Atlassian, Bitbucket. L’outil Bitbucket fournit un wiki qui peut être utilisé à des fins de documentation.

 

#de, #en, #ou, créé, des, documentation, je, ligne, objets, Outil, réutilisables, texte

 

wiki

Laisser un commentaire

Votre adresse e-mail ne sera pas publiée. Les champs obligatoires sont indiqués avec *