Pläne, die diese Funktion unterstützen: Professional Business Enterprise
Ein Projekt in Document360 dient als umfassender Container für all Ihre Dokumentationsbedürfnisse. Es kapselt Ihre Artikel, Kategorien, Unterkategorien, Startseite, Teamkonten, Leser und Gruppen (für private und gemischte Projekte) sowie benutzerdefinierte Konfigurationen oder Einstellungen. Dieser zentralisierte Ansatz stellt sicher, dass Ihre Wissensdatenbank organisiert, leicht zugänglich und skalierbar ist.
Wie erstellt man ein Wissensdatenbankprojekt in Document360?
Document360-Projekte sind darauf ausgelegt, Ihren Dokumentationsprozess zu optimieren und bieten eine strukturierte und effiziente Möglichkeit, Ihre Informationen zu verwalten. Egal, ob Sie Benutzerhandbücher, interne Prozessdokumente oder Dokumentationen erstellen – ein Document360-Projekt bietet das Rahmenwerk, um Inhalte effektiv zu speichern, zu verwalten und zu verteilen. Befolgen Sie diese Schritte, um Ihr Wissensdatenbankprojekt zu erstellen.
Zugriff auf das Dashboard
Melden Sie sich mit Ihrem Konto im Document360-Portal an, um auf das Dashboard zuzugreifen.
Wenn Sie eingeloggt sind und sich im Knowledge Base-Portal eines anderen Projekts befinden, klicken Sie auf das Document360-Symbol in der oberen Navigationsleiste, um zum Dashboard weitergeleitet zu werden.Klicken Sie oben rechts auf den +Project, um ein neues Projekt zu erstellen.
Wählen Sie Ihren Anwendungsfall
Wählen Sie Ihren primären Anwendungsfall für Document360 aus, indem Sie auf Starten klicken.
Anwendungsfall | Beschreibung |
|---|---|
Wissensdatenbankplattform | Sie können einen zentralen Hub einrichten, in dem das gesamte Wissen und die Ressourcen Ihres Teams gespeichert sind. Sie hilft Ihrem Team, schnell Antworten zu finden, und verbessert den Kundenservice, indem sie ihnen einfachen Zugang zu den benötigten Informationen bietet. |
Softwaredokumentation/Technische Dokumentation | Sie können Ihre gesamte Software oder technische Dokumentation effizient organisieren und pflegen. Sie hilft Ihrem Team, Produktfunktionen, APIs, Release Notes und mehr zu dokumentieren, sodass Entwickler und Nutzer klare und aktuelle Informationen erhalten. |
SOP-Dokumentation | Du kannst detaillierte SOPs erstellen, die dein Team konsequent einhalten kann. Es stellt sicher, dass alle die gleichen Prozesse einhalten, reduziert Fehler und erleichtert die Einarbeitung neuer Mitarbeiter durch klare Verfahrensrichtlinien. |
Benutzerhandbuch | Sie können umfassende Benutzerhandbücher entwickeln, die Ihre Kunden oder Teammitglieder durch die Funktionen und Nutzung Ihres Produkts führen. Es hilft, Support-Anfragen zu reduzieren, indem es Schritt-für-Schritt-Anleitungen und Tipps zur Fehlerbehebung bietet. |
API-Dokumentation | Dokumentieren Sie detaillierte Informationen zu API-Endpunkten, Anfrage- und Antwortformaten, Authentifizierungsmethoden und Beispielen. Dies stellt sicher, dass Entwickler ein klares Verständnis davon haben, wie sie sich mit Ihren APIs integrieren können. Wenn du diese Option auswählst, wirst du zum API-Einrichtungsablauf weitergeleitet. |
Weitere | Wählen Sie diese Option, wenn Ihr Anwendungsfall nicht in die vordefinierten Kategorien fällt. Sie können Ihre Wissensdatenbank individuell an spezifische organisatorische oder projektbezogene Bedürfnisse anpassen. |
Wählen Sie eine Vorlage aus
Wählen Sie die Art der Inhalte aus, die Sie in Ihrem Document360-Projekt erstellen möchten. Sie können bis zu zwei Vorlagen auswählen, die Ihren Bedürfnissen entsprechen.
HINWEIS
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, überspringst du diesen Schritt und 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. Das sorgt für ein reibungsloses Onboarding-Erlebnis. |
Anleitungen | Geben Sie detaillierte Anweisungen für bestimmte Aufgaben bereit, damit Nutzer die Funktionen Ihres Produkts effizient nutzen und erkunden können. |
FAQs | Beantworten Sie häufige Fragen in jeder Phase der Nutzerreise, helfen Sie den Nutzern, schnelle Antworten zu finden und Supportanfragen zu reduzieren. |
Richtlinien und Verfahren | Erstellen Sie wichtige organisatorische Protokolle, die den Nutzern helfen, Unternehmensrichtlinien effektiv 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 | Detaillierte Schritte und Verfahren, die in der Softwareentwicklung eingesetzt werden, um Arbeitsabläufe zu standardisieren und die Effizienz zu steigern. |
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, und sorgt für einen reibungslosen Start mit der Knowledge Base-Plattform. |
Bedienungsanleitung | Bietet Schritt-für-Schritt-Anleitungen zur Montage und Nutzung mit Diagrammen und Sicherheitshinweisen, ideal für eine präzise Einrichtung und Sicherheitshinweise für eine ordnungsgemäße Nutzung. |
Wartungshandbuch | Geben Sie detaillierte Anweisungen für regelmäßige Wartung, Fehlersuche und Reparaturverfahren bereit, um eine optimale Leistung zu gewährleisten. |
Trainingshandbuch | Bietet umfassende Anleitungen zu Installation, Betrieb und Fehlerbehebung sowie Unterstützung für Benutzerschulungen und effektive Nutzung der Plattform. |
Betriebshandbuch | Bereitstellen Sie detaillierte Anweisungen für die tägliche Wartung und Fehlerbehebung, um ein kontinuierliches und effektives Management der Knowledge Base-Plattform sicherzustellen. |
Personalisieren Sie Ihre Wissensdatenbank
Geben Sie die URL Ihres Unternehmens ein. Document360 analysiert Ihre Website und nutzt KI, um relevante Inhalte, Branding-Elemente und strukturierte Dokumentation zu generieren.
Wenn du diesen Schritt überspringen möchtest, wird die Domain standardmäßig auf die mit deiner Registrierungs-E-Mail verknüpfte Domain verwendet.
Markenrichtlinien
Ihr Projektname, Ihre Standardsprache, Ihr Branding-Logo und Ihre Markenfarben werden automatisch basierend auf der von Ihnen angegebenen URL festgelegt. Du kannst die Felder jedoch bei Bedarf bearbeiten.
Die Spracheinstellungen Ihres Browsers bestimmen die Standardsprache. Englisch wird standardmäßig ausgewählt, falls andere Sprachen die Sprache deines Browsers nicht unterstützen.
HINWEIS
Wenn du Spanisch oder brasilianisches Portugiesisch als Standardsprache wählst; die Portalsprache wird auf Spanisch oder brasilianisches Portugiesisch eingestellt. Andernfalls wird Englisch die Standardsprache sein.
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.
Sie können Ihre Knowledge Base-Seite auf der rechten Seite des Bildschirms vorschauen.
Dokumentation Privatsphäre festlegen
Wählen Sie die gewünschten Datenschutzeinstellungen für Ihre Seite aus:
Privat: Den Zugriff auf die Wissensdatenbank einschränken, sodass nur Teamkonten die Inhalte einsehen und mit ihnen interagieren können, wodurch sie sicher und intern bleiben.
Öffentlich: Machen Sie die Wissensdatenbank für alle, einschließlich externer Nutzer, zugänglich, sodass offener Zugang zu allen Inhalten möglich ist.
Gemischt: Kombiniert privaten und öffentlichen Zugang, indem einige Bereiche der Wissensdatenbank für die Öffentlichkeit sichtbar sind, während andere Bereiche nur auf Teamkonten beschränkt bleiben.
Klicken Sie auf Weiter, um fortzufahren.
Zugreifen Sie auf das Knowledge-Base-Portal Document360
Sobald Sie die Einrichtung abgeschlossen haben, betreten Sie das Portal der Document360 Knowledge Base.
Für Nutzer, die die Knowledge Base Platform, Softwaredokumentation/technische Dokumentation, SOP-Dokumentation oder Benutzerhandbuch als Anwendungsfall gewählt haben: Document360 generiert automatisch relevante Artikel und Kategorien basierend auf den ausgewählten Anwendungsfällen und dem Inhalt Ihrer Website. Jede Kategorie wird mindestens 2–3 KI-generierte Artikel enthalten, und bei Bedarf werden Unterkategorien erstellt. Wenn deine gewählte Sprache von Eddy AI unterstützt wird, wird deine Dokumentation in dieser Sprache erstellt. Wenn nicht, wird standardmäßig Englisch angezeigt. Wenn in der bereitgestellten URL keine relevanten Inhalte gefunden werden, sehen Sie vorinstallierte Artikel basierend auf Ihrem gewählten Anwendungsfall und Vorlagen, was Ihnen einen Vorsprung bei der Erstellung Ihrer Inhalte verschafft.
HINWEIS
Artikel, die von Eddy AI generiert werden, werden veröffentlicht und dann in den Entwurfsmodus versetzt. Du kannst die Artikel nach Bedarf aktualisieren.
Für Nutzer, die den API-Dokumentations-Anwendungsfall gewählt haben: Sie werden zum API-Dokumentations-Arbeitsbereich weitergeleitet, wo:
Sie sehen die API-Referenz der API-Spezifikation, die Sie beim Onboarding angegeben haben.
Wenn Sie keine API-Spezifikation bereitgestellt haben, ist eine Beispiel-API-Referenz (Pet Store API) verfügbar.
Wechsel zwischen Document360-Projekten
Sobald Sie Ihre Projekte in Document360 erstellt haben, müssen Sie möglicherweise an mehreren Projekten arbeiten oder zwischen ihnen für verschiedene Aufgaben wechseln. Document360 bietet einen intuitiven Projektwechsel, der Ihnen hilft, dies nahtlos zu verwalten.
Es gibt zwei Möglichkeiten, Projekte vom Knowledge Base-Portal zu wechseln:
Nutzung des Projekt-Dropdown-Menüs
Aus dem Projekt-Dashboard
Projektwechsel über das Dropdown-Menü Projekte
Klicken Sie von jedem Modul im Knowledge Base-Portal aus auf das Projekt-Dropdown-Menü in der oberen Navigationsleiste.
Sie können die Bezeichnungen "Projektname", "Site Access" (öffentlich - , privat - , oder gemischt ) und ein "Sandbox"-Label einsehen, wenn es sich um ein Sandbox-Projekt handelt.
Klicken Sie auf das Projekt, das Sie in der Liste ansehen möchten.
Projektwechsel vom Projekt-Dashboard
Klicken Sie auf das Document360-Logo in der oberen Navigationsleiste.
Du wirst auf die Your projects " weitergeleitet.
Die Liste aller Projekte, die Ihrem Konto gehören oder mit ihnen verknüpft sind, wird angezeigt.
Klicken Sie auf das Projekt, zu dem Sie navigieren möchten.
Häufig gestellte Fragen
Unterstützt Document360 verschiedene Sprachen im Onboarding-Flow?
Ja, Document360 bietet mehrsprachige Unterstützung im Onboarding-Flow, einschließlich Sprachen wie Englisch, Spanisch, brasilianisches Portugiesisch, Deutsch und Schwedisch. Im Document360-Portal ist die Sprachunterstützung jedoch derzeit auf Englisch, Spanisch und brasilianisches Portugiesisch beschränkt.
Kann ich das Aussehen und die Struktur meines Document360-Projekts anpassen?
Ja, Document360-Projekte bieten umfangreiche Anpassungsmöglichkeiten. Sie können das Aussehen und die Atmosphäre Ihrer Wissensdatenbank anpassen, indem Sie Ihre Startseite und Themen gestalten, das Branding Ihrer Organisation hinzufügen, redaktionell orientiert sind und Artikel in einer hierarchischen Struktur (Kategorien) organisieren, die Ihren Dokumentationsbedürfnissen entspricht.
Ist es möglich, Zugriff und Berechtigungen innerhalb von Document360-Projekten zu steuern?
Absolut. Document360 bietet robuste Zugriffskontrollen und Berechtigungseinstellungen. Sie können Team-Konten Rollen und Berechtigungen zuweisen und den Zugriff auf bestimmte Funktionen und Inhalte entsprechend deren Verantwortlichkeiten und Anforderungen einschränken oder gewähren.
Wie hilft Document360 bei der Versionskontrolle und der Dokumentationshistorie?
Document360-Projekte unterhalten ein umfassendes Artikelversionskontrollsystem, das als "Article Revisions" bezeichnet wird. Es speichert und verfolgt Änderungen an Artikeln automatisch, sodass man bei Bedarf zu früheren Versionen zurückgreifen kann. Dies gewährleistet die Integrität Ihrer Dokumentation und vereinfacht die Zusammenarbeit bei Inhaltsaktualisierungen.
Woran erkenne ich, an welchem Projekt ich gerade arbeite?
Sie können den Projektnamen in der oberen Navigationsleiste im Knowledge Base-Portal anzeigen.
Was passiert, wenn ich das Projekt, zu dem ich wechseln möchte, nicht sehe?
Stellen Sie sicher, dass Sie die notwendigen Zugriffsrechte für dieses Projekt haben. Wenn das Projekt immer noch nicht angezeigt wird, wenden Sie sich an Ihren Document360-Administrator um Unterstützung.
Was ist ein "Sandbox"-Projekt und worin unterscheidet es sich von anderen Projekten?
Ein Sandbox-Projekt ist eine Testumgebung, in der du experimentieren kannst, ohne deine Live-Projekte zu beeinflussen. Im Projekt-Dropdown-Menü gibt es ein "Sandbox"-Label.
Was bedeutet "Site Access" im Projekt-Dropdown-Menü?
"Site Access" gibt an, ob das Projekt öffentlich, privat oder gemischt ist. Dies definiert das Zugänglichkeitsniveau der Projektinhalte.
Wie kann ich Zugang zu einem Projekt beantragen, mit dem ich derzeit nicht verbunden bin?
Kontaktieren Sie Ihren Teamadministrator oder den Projektverantwortlichen, um Zugang zum gewünschten Projekt zu beantragen.
Was passiert, wenn Eddy AI keine Inhalte von meiner Website für die Standardartikel generieren kann?
Wenn Eddy AI nicht genügend Inhalte von Ihrer Website extrahieren kann, verwendet das System Standardvorlagen basierend auf Ihrem gewählten Anwendungsfall.
Wie viele Projekte kann ich in Document360 erstellen?
Du kannst in Document360 so viele Projekte erstellen, wie du möchtest. Jedes neue Projekt kommt mit einer 14-tägigen kostenlosen Testphase, danach müssen Sie für dieses Projekt ein separates Abonnement abschließen.
Warum kann ich die Sichtbarkeit der Seite meines Probeprojekts nicht ändern?
Standardmäßig sind alle Testprojekte in Document360 auf Privatsphäre gesetzt, um Ihre Inhalte während der Bewertung zu schützen und unbeabsichtigte Entlarvungen zu verhindern. Du wirst feststellen, dass die Optionen Gemischte und Öffentliche Sichtbarkeit sowohl im Onboarding-Bildschirm als auch auf der Seite der Seitenzugangseinstellungen deaktiviert (ausgegraut) sind.
Wenn Sie die Sichtbarkeit Ihres Testprojekts ändern möchten:
Klicken Sie auf den Link Kontaktvertrieb, der im Info-Banner angezeigt wird.
Dies löst eine automatisierte E-Mail-Anfrage an unser Vertriebsteam mit Ihren Projektdetails aus.
Sobald Ihre Anfrage validiert ist, sendet das Vertriebsteam eine Bestätigungs-E-Mail.
Anschließend können Sie die Sichtbarkeit Ihres Projekts über die Seitenzugangseinstellungen auf Gemischt oder Öffentlich umstellen.
HINWEIS
Diese Einschränkung sorgt dafür, dass Ihr Projekt sicher bleibt, bis Sie bereit sind, es öffentlich zugänglich zu machen.