it-swarm.com.de

Wordpress-Plugin zum Verfassen von technischer Dokumentation?

Wir möchten WordPress verwenden, um die technische Dokumentation für unser Softwareprodukt zu erstellen. Wir haben einfache alte WordPress-Seiten verwendet, die dann hierarchisch angeordnet sind, und es funktioniert, aber es ist nicht großartig. Die Probleme:

  • Der Wordpress-Seiteneditor ist sehr langsam.
  • Sie können keine Seiten ziehen und ablegen, um die Hierarchie zu ändern
  • Die Nummerierung der Abschnitte bleibt unverändert wie in den Abschnitten 1.1, 1.2, 1.2.3.
  • Ich habe keine Möglichkeit gefunden, ein automatisch erstelltes Inhaltsverzeichnis auf der rechten Seite zu erstellen.
  • Ich hätte gerne ein Tag zum Hervorheben und Einrücken von Code.

Ich könnte wahrscheinlich eine Sammlung von Plugins zusammenstellen, um all diese Dinge zu erledigen, aber wir haben bereits eine ganze Menge Zeit dafür aufgewendet und haben immer noch keine großartige Lösung.

Confluence wäre ein guter Weg, aber ich möchte alles in Wordpress behalten.

Irgendwelche Vorschläge für gute Plugins zur technischen Dokumentation?

2
user237815

Du wirst mit einigen Plugins gehen müssen.

Der Wordpress-Seiteneditor ist sehr langsam.

Werfen Sie mehr Ressourcen darauf und/oder deaktivieren Sie, dass einige Funktionen auf der Registerkarte "Bildschirmoptionen" angezeigt werden. Es sollte nicht wirklich langsam sein, es sei denn, Sie haben eine Tonne Leute, die gleichzeitig an einer Tonne Seiten arbeiten, wenn Sie klären können, warum es langsam ist.

Sie können keine Seiten ziehen und ablegen, um die Hierarchie zu ändern

Dazu benötigen Sie ein Plugin wie http://wordpress.org/extend/plugins/simple-page-ordering/

Nichts behält die Abschnittsnummerierung bei, wie in den Abschnitten 1.1, 1.2, 1.2.3.

Hier haben Sie zwei Möglichkeiten: Erstellen Sie ein benutzerdefiniertes Feld mit der Bezeichnung "Abschnitte" und geben Sie eine Zahl für den Wert auf jeder Seite ein. Dies ist einfach abzufragen und anzuzeigen, es ist jedoch keine Hierarchie integriert. Option 2 wäre, Kategorien (oder eine benutzerdefinierte Taxonomie) für Seiten zu verwenden und sie als Hierarchie zu haben (dies ermöglicht auch einfachere Slugs), oder einfach ein CPT zu verwenden.

Ich habe keine Möglichkeit gefunden, ein automatisch erstelltes Inhaltsverzeichnis auf der rechten Seite zu erstellen.

Hierfür gibt es verschiedene Plugins. Durchsuchen Sie wordpress.org nach "TOC". Oder wenn Sie die oben genannten Methoden verwenden, können Sie einige integrierte WordPress-Funktionen verwenden (insbesondere, wenn Sie eine Abschnittstaxonomie erstellen).

Ich hätte gerne ein Tag zum Hervorheben und Einrücken von Code.

Ich mag dieses, http://wordpress.org/extend/plugins/syntaxhighlighter/ , aber es gibt andere, die auf .org gut sind.

5
Wyck

Ich benutze WordPress zur Dokumentation. Ich benutze die folgenden Plugins

Für das Inhaltsverzeichnis auf der rechten Seite verwende ich ein Plugin mit dem Namen "Inhaltsverzeichnis plus". Ich verwende einen Funktionscode [toc], um ein Inhaltsverzeichnis in Seiten einzufügen.

Zum hierarchischen Ordnen von Seiten verwende ich ein Plugin mit dem Namen "CMS-Seitenbaumansicht". Auf diese Weise können Sie Seiten oder Seitengruppen per Drag & Drop verschieben.

Meins war eine Umstellung von Robohelp auf WordPress, und ich brauchte einen Seitennavigationsbaum in der linken Seitenleiste. Ich benutze dafür ein Plugin namens 'wp-page tree'.

2
Roy Joe