Ein Document360-Projekt ist ein eigenständiger Arbeitsbereich, der alle Inhalte Ihrer Wissensdatenbank enthält – Artikel, Kategorien, Unterkategorien, Startseite, Nutzer, Leser, Gruppen (für private und gemischte Projekte) und benutzerdefinierte Konfigurationen. Ein Projekt zu erstellen ist der erste Schritt zum Aufbau einer Wissensdatenbank in Document360, egal ob Sie Software, SOPs, APIs oder Benutzerhandbücher dokumentieren.
Wie man ein Projekt in Document360 erstellt
Zugriff auf das Dashboard
- Melden Sie sich mit Ihrem Konto im Document360-Portal an, um auf das Dashboard zuzugreifen.
Wenn Sie sich bereits in einem Projekt befinden, klicken Sie auf das Document360-Logo in der oberen Navigationsleiste, um zum Dashboard zurückzukehren. - Klicken Sie auf die Schaltfläche + Projekt oben rechts.
Wählen Sie Ihren Anwendungsfall
- Wählen Sie Ihren Hauptanwendungsfall aus und klicken Sie auf Starten gehen.
| Anwendungsfall | Beschreibung |
|---|---|
| Wissensdatenbankplattform | Schaffen Sie einen zentralen Hub, in dem das gesamte Wissen und die Ressourcen Ihres Teams gespeichert sind. Es hilft Ihrem Team, schnell Antworten zu finden, und verbessert den Kundenservice. |
| Software-/Technische Dokumentation | Organisieren und pflegen Sie effizient alle Ihre Software oder technischen Dokumentationen – Produktfunktionen, APIs, Release Notes und mehr. |
| SOP-Dokumentation | Erstellen Sie detaillierte SOPs, die Ihr Team konsequent einhalten kann, um Fehler zu reduzieren und die Einarbeitung der Mitarbeiter zu erleichtern. |
| Benutzerhandbuch | Entwickeln Sie umfassende Benutzerhandbücher, die Kunden oder Teammitglieder durch die Funktionen und Nutzung Ihres Produkts führen. |
| API-Dokumentation | Dokumentieren Sie detaillierte Informationen zu API-Endpunkten, Anfrage- und Antwortformaten, Authentifizierungsmethoden und Beispielen. Wenn du diese auswählst, wirst du zum API-Einrichtungsflow weitergeleitet. |
| Weitere | Wählen Sie dies, wenn Ihr Anwendungsfall nicht in die vordefinierten Kategorien fällt. |
Wählen Sie eine Vorlage aus
- Wählen Sie bis zu zwei Inhaltsvorlagen aus, die zur Art der Dokumentation passen, die Sie erstellen möchten. Diese Vorlagen sind während der Erstellung in Ihr Projekt eingebettet, um Ihnen einen Vorsprung zu verschaffen.
- Je nach Auswahl werden diese Vorlagen während der Erstellung in Ihr Projekt eingebettet. Ihre Auswahl schränkt Sie jedoch nicht daran, andere Funktionen zu nutzen oder verschiedene Arten von Inhalten zu erstellen.
- Wenn du API-Dokumentation als Anwendungsfall ausgewählt hast, wird dieser Schritt übersprungen und du wirst stattdessen zur API-Einrichtung weitergeleitet.
Vorlagen für Wissensdatenbank-Plattformen
Wenn Sie in Schritt 3 die Knowledge Base-Plattform ausgewählt haben, können Sie zwei beliebige Vorlagen aus der untenstehenden Liste auswählen.
| Vorlage | Zweck |
|---|---|
| Anfangsleitfäden | Helfen Sie neuen Nutzern, Ihr Produkt schnell zu verstehen und mit klaren, schrittweisen Anleitungen zu beginnen. |
| Anleitungen | Geben Sie detaillierte Anweisungen für spezifische Aufgaben bereit, damit Nutzer die Funktionen Ihres Produkts voll nutzen können. |
| FAQs | Beantworten Sie häufige Fragen in jeder Phase der Nutzerreise und reduzieren Sie Support-Anfragen. |
| Richtlinien und Verfahren | Erstellen Sie wichtige Organisationsprotokolle, um den Nutzern zu helfen, Unternehmensrichtlinien zu verstehen und einzuhalten. |
Software-/Technische Dokumentationsvorlagen
Wenn Sie in Schritt 3 Software-/Technische Dokumentation ausgewählt haben, können Sie zwei beliebige Vorlagen aus der untenstehenden Liste auswählen.
| Vorlage | Zweck |
|---|---|
| Veröffentlichungsnotizen | Halten Sie die Nutzer über Updates, neue Funktionen, Fehlerbehebungen und Verbesserungen bei jeder Softwareversion auf dem Laufenden. |
| Softwaredesign-Dokumentation (SDD) | Skizzieren Sie Softwarearchitektur und -design, einschließlich Diagrammen und Spezifikationen für Entwicklungsleitlinien. |
| Softwareanforderungsdokumentation | Beschreiben Sie den Zweck, die Funktionalitäten und die Umgebung der Software, um sicherzustellen, dass die Entwicklung mit den Projektzielen übereinstimmt. |
| Produktanforderungsdokumentation (PRD) | Definieren Sie den Zweck, den Wert und die Funktionalitäten des Produkts, um den Bedürfnissen und Geschäftszielen der Nutzer gerecht zu werden. |
| Prozessdokumentation | Dokumentieren Sie detaillierte Schritte und Verfahren in der Softwareentwicklung, um Arbeitsabläufe zu standardisieren. |
| Benutzerhandbuch | Geben Sie umfassende Anweisungen zur Nutzung Ihres Produkts und decken alle Funktionen ab. |
SOP-Dokumentationsvorlagen
Wenn Sie in Schritt 3 die SOP-Dokumentation ausgewählt haben, können Sie Vorlagen aus der untenstehenden Liste auswählen.
| Vorlage | Zweck |
|---|---|
| Compliance-Richtlinien und -verfahren | Stellen Sie sicher, dass Ihre Organisation regulatorische Anforderungen erfüllt, indem Sie Richtlinien dokumentieren, die die Einhaltung der Vorschriften gewährleisten. |
| Operation SOP | Steigern Sie Effizienz und Produktivität, indem Sie operative Abläufe in Ihrer Organisation standardisieren. |
Benutzerhandbuch-Vorlagen
Wenn Sie das Benutzerhandbuch in Schritt 3 ausgewählt haben, können Sie zwei beliebige Vorlagen aus der untenstehenden Liste auswählen.
| Vorlage | Zweck |
|---|---|
| Installationshandbuch | Stellt alle notwendigen Einrichtungsinformationen bereit, einschließlich Produktübersicht, Spezifikationen und Montageanweisungen. |
| Bedienungsanleitung | Bietet Schritt-für-Schritt-Anleitungen zur Montage und Nutzung mit Diagrammen und Sicherheitswarnungen. |
| Wartungshandbuch | Bietet detaillierte Anweisungen für regelmäßige Wartung, Fehlersuche und Reparaturverfahren. |
| Trainingshandbuch | Bietet umfassende Anleitungen zu Installation, Bedienung, Fehlerbehebung und Benutzerschulungen. |
| Betriebshandbuch | Bietet detaillierte Anweisungen für tägliche Wartung und Fehlerbehebung für ein effektives Plattformmanagement. |
Personalisieren Sie Ihre Wissensdatenbank
- Geben Sie die Website Ihres Unternehmens ein. Document360 analysiert Ihre Website und nutzt KI, um relevante Inhalte, Branding-Elemente und einen strukturierten Dokumentationsrahmen zu erstellen.
Wenn Sie diesen Schritt überspringen möchten, verwendet die Domain standardmäßig die, die mit Ihrer Registrierungs-E-Mail verknüpft ist.
Markenrichtlinien festlegen
- Überprüfen Sie den automatisch ausgefüllten Projektnamen, die Standardsprache, das Branding-Logo und die Markenfarben , die aus Ihrer Website-URL extrahiert wurden. Bearbeiten Sie alle Felder nach Bedarf.
Die Spracheinstellungen Ihres Browsers bestimmen die Standardsprache. Englisch ist standardmäßig ausgewählt, wenn die Browsersprache nicht unterstützt wird. - Schauen Sie Ihre Wissensdatenbank-Seite im rechten Panel vor.
- Wenn du Spanisch oder brasilianisches Portugiesisch als Standardsprache wählst, ist die Portalsprache auf Spanisch oder brasilianisches Portugiesisch eingestellt. Ansonsten ist Englisch die Standard-Portalsprache.
- Das Branding-Logo und die Primär- und Sekundärfarben werden von Ihrer Website extrahiert. Wenn Sie diesen Schritt überspringen , wird der Projektname aus Ihrer Registrierungs-E-Mail abgeleitet und das Standardlogo und die Farben von Document360 werden angewendet.
Dokumentation Privatsphäre festlegen
- Wählen Sie die Datenschutzeinstellung für Ihre Wissensdatenbank:
| Privatsphäremodus | Was es bedeutet |
|---|---|
| Gefreiter | Beschränken Sie den Zugriff, sodass nur registrierte Nutzer die Inhalte ansehen und mit ihnen interagieren können, und halten Sie sie sicher und intern. |
| Öffentlich | Machen Sie die Wissensdatenbank für alle zugänglich, auch für externe Nutzer, ohne dass ein Login erforderlich ist. |
| Gemischt | Kombinieren Sie privaten und öffentlichen Zugang – einige Bereiche sind für die Öffentlichkeit sichtbar, während andere nur registrierten Nutzern vorbehalten sind. |
- Klicken Sie auf Weiter, um fortzufahren.
- Sie können die Datenschutzeinstellungen jederzeit nach der Projekterstellung über Einstellungen > Benutzer & Berechtigungen > Leserzugriff aktualisieren. Weitere Informationen finden Sie unter Site-Zugang.
- Über den Datenschutz auf Seitenebene hinaus ermöglicht Document360 Ihnen auch, den Zugriff auf Benutzerebene zu steuern. Sie können Teammitgliedern Rollen und Berechtigungen zuweisen und Zugang zu bestimmten Funktionen und Inhalten entsprechend deren Aufgaben einschränken oder gewähren. Weitere Informationen finden Sie unter Rollen und Berechtigungen.
Zugriff auf das Knowledge Base Portal
Sobald die Einrichtung abgeschlossen ist, wirst du in das Knowledge-Base-Portal von Document360 aufgenommen.
- Für Knowledge Base-Plattform, Softwaredokumentation, SOP-Dokumentation oder Benutzerhandbuch-Anwendungsfälle: Document360 generiert automatisch relevante Artikel und Kategorien basierend auf Ihrem gewählten Anwendungsfall und Website-Inhalt. Jede Kategorie umfasst mindestens 2–3 KI-generierte Artikel, und Unterkategorien werden bei Bedarf erstellt. Wenn Ihre gewählte Sprache von Eddy AI unterstützt wird, wird die Dokumentation in dieser Sprache erstellt; ansonsten wird standardmäßig auf Englisch zurückgegriffen. Wenn an der angegebenen URL kein relevanter Inhalt gefunden wird, werden vorinstallierte Artikel basierend auf Ihrem Anwendungsfall und Vorlagen angezeigt.
- Artikel, die von Eddy AI generiert werden, werden zuerst veröffentlicht und dann automatisch in den Entwurfsmodus gestellt. Sie können sie bei Bedarf überprüfen und aktualisieren.
- Sobald Ihr Projekt erstellt ist, können Sie sein Aussehen und seine Struktur über die Einstellungen anpassen – einschließlich Startseite, Themen, Branding und Kategorienhierarchie.
- Für API-Dokumentations-Anwendungsfälle: Sie werden zum API-Dokumentationsarbeitsbereich weitergeleitet. Sie sehen die API-Referenz für die Spezifikation, die Sie beim Onboarding angegeben haben. Falls keine Spezifikation bereitgestellt wurde, ist eine Beispiel-Pet Store API-Referenz verfügbar.
Wechsel zwischen Projekten
Sobald du mehrere Projekte hast, kannst du innerhalb des Knowledge Base-Portals auf zwei Arten zwischen ihnen wechseln.
- Nutzung des Projekt-Dropdown-Menüs
- Aus dem Projekt-Dashboard
Projektwechsel über das Projektauswahlmenü
- Klicken Sie von jedem Modul aus im Knowledge Base-Portal auf das Projektauswahlmenü in der oberen Navigationsleiste.
- Jeder Projekteintrag zeigt den Projektnamen, den Leserzugriffstyp – öffentlich , privat oder gemischt – und ein Sandbox-Label , falls es sich um ein Sandbox-Projekt handelt.
- Klicken Sie auf das Projekt, das Sie öffnen möchten.
Projektwechsel über das Projekt-Dashboard
- Klicken Sie auf das Document360-Logo in der oberen Navigationsleiste.
Alternativ klicken Sie in der oberen Navigationsleiste auf das Dropdown-Menü der Projektauswahl und wählen Sie unten im Dropdown-Menü die Fußzeile "Projekte verwalten ".
Sie werden auf die Seite "Ihre Projekte " weitergeleitet, wo alle Projekte, die Sie besitzen oder mit denen Sie verbunden sind, aufgeführt sind.
- Klicken Sie auf die Projektkachel, zu der Sie navigieren möchten.
Sie können erkennen, in welchem Projekt Sie derzeit arbeiten, indem Sie den Projektnamen in der oberen Navigationsleiste des Knowledge Base Portals überprüfen.
Projektdetails
| Gegenstand | Detail |
|---|---|
| Probezeit des Projekts | Jedes neue Projekt beinhaltet eine 14-tägige kostenlose Testphase. Nach Ablauf der Testphase ist ein separates Abonnement erforderlich. |
| Onboarding-Sprachunterstützung | Der Onboarding-Fluss unterstützt Englisch, Spanisch, brasilianisches Portugiesisch, Deutsch und Schwedisch. Das Portal selbst unterstützt ausschließlich Englisch, Spanisch und brasilianisches Portugiesisch. |
Best Practices
- Benennen Sie Ihr Projekt vor der Erstellung klar. Der Projektname beeinflusst die Standard-URL und das Branding. Das Wechseln nach der Einrichtung erfordert zusätzliche Konfigurationsschritte.
- Nutze ein Sandbox-Projekt zum Testen. Bevor Sie Themen, Arbeitsabläufe oder Integrationen in einem Live-Projekt ändern, testen Sie Ihre Änderungen in einer Sandbox, um Ihre Leser nicht zu stören. Siehe Ein Sandbox-Projekt erstellen.
- Führen Sie pro Wissensdatenbank ein Projekt auf. Vermeide es, nicht zusammenhängende Dokumentationen in einem einzigen Projekt zu mischen. Separate Projekte gewährleisten unabhängige Zugriffskontrolle, Branding und Analysen.
FAQ
Unterstützt Document360 verschiedene Sprachen im Onboarding-Flow?
Ja, der Onboarding-Flow unterstützt Englisch, Spanisch, brasilianisches Portugiesisch, Deutsch und Schwedisch. Das Document360-Portal selbst unterstützt derzeit jedoch nur Englisch, Spanisch und brasilianisches Portugiesisch.
Was ist ein "Sandbox"-Projekt und worin unterscheidet es sich von einem normalen Projekt?
Ein Sandbox-Projekt ist eine isolierte Testumgebung, in der Sie mit Einstellungen, Designs und Arbeitsabläufen experimentieren können, ohne Ihre Live-Wissensdatenbank zu beeinträchtigen. Sie erscheint mit einem Sandbox-Label im Projekt-Dropdown-Menü. Weitere Informationen finden Sie unter Erstellung eines Sandbox-Projekts.
Wie handhabt Document360 die Versionskontrolle für Artikel?
Document360 pflegt eine umfassende Artikelversionsgeschichte namens Artikelrevisionen. Jede Änderung eines Artikels wird automatisch gespeichert und nachverfolgt, sodass Sie bei Bedarf auf eine beliebige vorherige Version zurücksetzen können.
Wie kann ich Zugang zu einem Projekt beantragen, mit dem ich nicht verbunden bin?
Kontaktiere deinen Teamadministrator oder den Projektverantwortlichen und bitte ihn, dich hinzuzufügen. Sie können Ihnen eine passende Portalrolle und Inhaltszugriff aus Einstellungen > Benutzer und Berechtigungen zuweisen.