web-dev-qa-db-fra.com

Plugin Wordpress pour la création de documentation technique?

Nous aimerions utiliser WordPress pour créer la documentation technique de notre produit logiciel. Nous avons utilisé d'anciennes pages WordPress, organisées puis hiérarchiquement, et cela fonctionne bien, mais ce n'est pas génial. Les problèmes:

  • L'éditeur de page Wordpress est chien lent.
  • Vous ne pouvez pas faire glisser des pages pour changer la hiérarchie
  • Rien ne maintient la numérotation des sections, comme les sections 1.1, 1.2, 1.2.3.
  • Je n'ai pas trouvé le moyen de créer une table des matières créée automatiquement du côté droit.
  • Je voudrais avoir une balise pour mettre en évidence et indenter le code.

Je pourrais probablement constituer une collection de plugins pour faire tout cela, mais nous avons déjà passé pas mal de temps dessus, et nous n’avons toujours pas de bonne solution.

Confluence serait un bon chemin à parcourir, mais j'aimerais tout garder dans Wordpress.

Des suggestions pour de bons plugins de documentation technique?

2
user237815

Vous allez devoir aller avec des plugins.

L'éditeur de page Wordpress est dog slow.

Jetez plus de ressources et/ou désactivez l'affichage de certaines fonctions dans l'onglet "Options d'écran". Cela ne devrait pas vraiment être lent sauf si vous avez une tonne de personnes travaillant sur une tonne de pages en même temps, si vous pouvez clarifier quoi/pourquoi c'est lent.

Vous ne pouvez pas faire glisser des pages pour modifier la hiérarchie

Vous aurez besoin d'un plugin pour cela, comme http://wordpress.org/extend/plugins/simple-page-ordering/

Rien ne conserve la numérotation des sections, comme les sections 1.1, 1.2, 1.2.3.

Vous avez deux options ici, créer une méta-zone de champ personnalisé appelée "Sections" et entrer un nombre pour la valeur sur chaque page. Cette requête est simple à interroger et à afficher, mais ne possède pas de hiérarchie intégrée. L'option 2 consisterait à utiliser des catégories (ou une taxonomie personnalisée) pour les pages et à les hiérarchiser (ce qui permet également des slugs plus faciles), ou simplement à utiliser un CPT .

Je n'ai pas trouvé le moyen de créer une table des matières créée automatiquement du côté droit.

Il existe différents plugins pour cela, recherchez wordpress.org pour "TOC". Ou si vous utilisez les méthodes mentionnées ci-dessus, vous pouvez utiliser certaines fonctions intégrées de WordPress (en particulier si vous créez une taxonomie de section).

J'aimerais avoir une balise pour mettre en surbrillance et mettre en retrait le code.

J'aime celui-ci, http://wordpress.org/extend/plugins/syntaxhighlighter/ , mais il y en a d'autres qui sont bons sur .org.

5
Wyck

J'utilise WordPress pour la documentation. J'utilise les plugins suivants

Pour la table des matières à droite des pages, j'utilise un plugin nommé "table des matières plus". J'utilise un code court [toc] pour insérer une table des matières dans des pages.

Pour commander les pages de manière hiérarchique, j'utilise un plugin nommé "Vue de l'arborescence de pages CMS". Cela vous permet de glisser-déposer des pages ou un groupe de pages.

Le mien était un passage de Robohelp à WordPress, et j'avais besoin d'un arbre de navigation de page sur la barre latérale gauche. J'utilise un plugin nommé 'wp-page tree' pour cela.

2
Roy Joe