Unternehmensdokumentation in Markdown und Pandoc schreiben

1235
TheSavo

Hintergrund

Ich habe ein paar Freunde habe, die mich eingeschaltet markdownund pandocDokumentation für das Schreiben. In meinem aktuellen Job verwenden wir Microsoft Word, um unstrukturierte, einmalige Anleitungen für unsere Endbenutzer zu erstellen. Ich möchte aus folgenden Gründen anfangen, sie in Abschriften zu schreiben.

  1. Trennung von Inhalt und Struktur.
  2. die Möglichkeit, Änderungssteuerungssysteme zur Nachverfolgung von Aktualisierungen zu verwenden
  3. Erstellen Sie eine Standardvorlage, die ein Logo, einen Boilerplate-Firmentext und ein Layout enthält, das in allen nachfolgenden Dokumentationen verwendet wird.

Ich möchte einige Vorlagen erstellen, mit denen alle Dokumente den gleichen Informationsfluss für unsere Benutzer enthalten können. Das Ziel ist, der Benutzerdokumentation unserer IT-Abteilung einen professoralen Look zu verleihen.

Ich kann mir vorstellen, dass ein von einem Unternehmen gehostetes Wiki ausreicht, aber die Entscheidungsträger lassen dies zu diesem Zeitpunkt nicht zu.

Frage

Ich suche nach Hilfe beim Hinzufügen von Elementen wie einem Logo und Standardtext, der einer HTML- oder PDF-Vorlage hinzugefügt werden kann. Außerdem möchte ich Makros definieren, die ein Wort in !Pony einkapseln und dieses Wort entsprechend einer Reihe von Regeln hervorheben, z. B. Tasten auf einer Tastatur oder Schaltflächen einer Software-Benutzeroberfläche. Im Gegensatz dazu würde ein Verkapseln eines Wortes in &Et-Zeichen den Stil ändern, um den Namen eines GUI-Menüelements anzugeben.

2
Das ist wahrscheinlich ein gutes Ziel, aber Sie haben keine Frage gestellt. Stephen Jennings vor 11 Jahren 5
Diese Frage ist zu breit. Bitte lesen Sie ein [Tutorial] (https://www.google.se/search?q=markdown+tutorial+%2Bpandoc) und kehren Sie zurück, wenn Sie spezifische Fragen haben. Nifle vor 11 Jahren 0
Wenn Sie immer noch suchen, kann dies helfen: http://superuser.com/questions/87273/desktop-app-for-wiki-like-markdown-markups/87277#87277 cregox vor 10 Jahren 0

0 Antworten auf die Frage

Verwandte Probleme