...
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:
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)
bei Unklarheiten zur Schreibweise /wiki/spaces/CORE/pages/50890256 zu Rate ziehen (Glossar ggf. in Absprache mit Magdalena ergänzen)
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
...
Verwandte Seiten
| Filter by label (Content by label) | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|
|
| Include Page | ||||
|---|---|---|---|---|
|
Nur für PEIQ-Mitarbeiter:innen
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.
Dann diesen Hinweis entfernen (auf Mülleimer drücken).
...