...
Funktionalitäten des/der [Moduls/Features/Funktion/Schnittstelle]
| Status | ||||
|---|---|---|---|---|
|
| Info |
|---|
Inhaltsverzeichnis
| Expand | ||||
|---|---|---|---|---|
| ||||
|
[Externe Produktdokumentation]
Layout-Funktionalitäten von Confluence nutzen (können über / gesucht werden) :
...
Wichtige Hinweise:
...
Label für die Seite vergeben: Neben “portal” und “dokumentation” muss mindestens noch das Label der übergeordneten Seite (z.B. “newsletter”) vergeben werden. Unten rechts auf der Seite findet sich das Icon für “Label hinzufügen”. Hier das Label ergänzen und über den “Hinzufügen”-Button speichern.lab
...
spätere Verlinkungen rot markieren
...
Alle Bilder haben eine Bildunterschrift
...
keine direkte Ansprache (“können Sie” / “Ihr Portal”; Tipp: Seiten nach “Sie” und “Ihnen” / “Ihr” über Strg + F durchsuchen)
...
“man” möglichst vermeiden
...
Fachbegriffe erklären (Bsp. API: Begriff ausschreiben sowie deutschen Begriff nennen, Hover: mithilfe einer Umschreibung den Begriff erklären) bzw. auf eine externe Seite mit ausführlicher Erklärung (z.B. Wikipedia) verlinken (Bsp. REST-Architektur, OAuth V2 Standard)
...
...
Inhaltsverzeichnis überprüfen (evtl. Überschrift durch Fettung ersetzen, um das Inhaltsverzeichnis nicht zu überladen)
...
Nach Fertigstellen der Seite nochmal überprüfen (z.B. nach doppelten Leerzeichen durchsuchen) und jemandem zum Korrektur lesen geben
→ siehe auch https://peiq.atlassian.net/wiki/pages/createpage.action?spaceKey=CORE&title=Tipps%3A+Dokumentieren+mit+Confluence (hier gerne auch Tipps ergänzen bzw. Bug Liste füllen, wenn man beim Dokumentieren auf Bugs stößt)
Verwandte Seiten
Das untenstehende Makro “Inhalt nach Stichwort” bearbeiten und in der Seitenleiste unter “Stichwort *” das Label “dummy” durch das Label des Moduls / Features ersetzen.
...
| Filter by label (Content by label) | ||||||
|---|---|---|---|---|---|---|
|
...