Pläne zur Unterstützung der Erstellung eines neuen Projekts
| Professionell | Geschäft | Unternehmen |
|---|---|---|
Ein Projekt in Document360 dient als umfassender Container für alle Ihre Dokumentationsanforderungen. Es umfasst Ihre Beiträge, Kategorien und Unterkategorien, die 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 erstelle ich ein Wissensdatenbank-Projekt in Document360?
Projekte in Document360 sind darauf ausgelegt, Ihren Dokumentationsprozess zu rationalisieren und eine strukturierte und effiziente Möglichkeit zur Verwaltung Ihrer Informationen zu bieten. Unabhängig davon, ob Sie Benutzerhandbücher, interne Prozessdokumente oder API Dokumentation erstellen, bietet ein Document360-Projekt den Rahmen für die effektive Speicherung, Verwaltung und Verteilung von Inhalten. Führen Sie die folgenden Schritte aus, um Ihr Wissensdatenbankprojekt zu erstellen.
Zugriff auf das Dashboard
Melden Sie sich mit Ihrem Konto beim Document360-Portal an, um auf die Dashboardzuzugreifen.
Wenn Sie angemeldet sind und sich im Wissensdatenbank-Portal eines anderen Projekts befinden, klicken Sie oben links auf das Document360-Symbol, um zur Dashboardweitergeleitet zu werden.Klicken Sie oben rechts auf die Schaltfläche +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 Erste Schritte klicken.
Anwendungsfall | Beschreibung |
Wissensdatenbank-Plattform | Sie können einen zentralen Hub erstellen, in dem das gesamte Wissen und die Ressourcen Ihres Teams gespeichert werden. Es hilft Ihrem Team, schnell Antworten zu finden, und verbessert den Self-Service der Kunden, indem es ihnen einen einfachen Zugang zu den benötigten Informationen bietet. |
Softwaredokumentation/Technische Dokumentation | Sie können Ihre gesamte Software oder technische Dokumentation effizient organisieren und pflegen. Es hilft Ihrem Team, Produktfunktionen, APIs, Versionshinweise und mehr zu dokumentieren und stellt sicher, dass Entwickler und Benutzer über klare und aktuelle Informationen verfügen. |
SOP-Dokumentation | Sie können detaillierte SOPs erstellen, die Ihr Team konsequent befolgen kann. Es stellt sicher, dass sich alle an die gleichen Prozesse halten, reduziert Fehler und hilft beim Onboarding neuer Mitarbeiter, indem es ihnen klare Verfahrensrichtlinien an die Hand gibt. |
Benutzerhandbuch | Sie können umfassende Benutzerhandbücher entwickeln, die Ihre Kunden oder Teammitglieder durch die Funktionen und die Nutzung Ihres Produkts führen. Es hilft bei der Reduzierung von Supportanfragen, indem es Schritt-für-Schritt-Anleitungen und Tipps zur Fehlerbehebung bietet. |
API-Dokumentation | Dokumentieren Sie detaillierte Informationen zu API-Endpunkten, Anforderungs- und Antwortformaten, Authentifizierungsmethoden und Beispielen. Dies stellt sicher, dass Entwickler ein klares Verständnis davon haben, wie sie Ihre APIs integrieren können. Wenn Sie diese Option auswählen, werden Sie zum API-Einrichtungsablauf weitergeleitet. |
Andere | Wählen Sie diese Option aus, wenn Ihr Anwendungsfall nicht in die vordefinierten Kategorien fällt. Sie können Ihre Wissensdatenbank an spezifische Organisations- oder Projektanforderungen anpassen. |
Wählen Sie eine Vorlage aus
Wählen Sie den Typ des Inhalts aus, den Sie in Ihrem Document360-Projekt erstellen möchten. Sie können bis zu zwei Vorlagen auswählen, die Ihren Anforderungen entsprechen.
ANMERKUNG
Basierend auf Ihrer Auswahl werden diese Vorlagen während der Erstellung in Ihr Projekt eingebettet. Ihre Auswahl hindert Sie jedoch nicht daran, andere Funktionen zu verwenden oder verschiedene Arten von Inhalten zu erstellen.
Wenn Sie API-Dokumentation als Anwendungsfall ausgewählt haben, überspringen Sie diesen Schritt und werden stattdessen zur API-Einrichtung weitergeleitet.
Vorlagen für Wissensdatenbank-Plattformen
Wenn Sie in Schritt 3 die Wissensdatenbank-Plattform ausgewählt haben, können Sie zwei beliebige Vorlagen aus der folgenden Liste auswählen.
Schablone | Zweck |
Leitfäden für die ersten Schritte | Helfen Sie neuen Benutzern, Ihr Produkt schnell zu verstehen und zu verwenden, mit klaren Schritt-für-Schritt-Anweisungen. Dies gewährleistet ein reibungsloses Onboarding-Erlebnis. |
Anleitungen | Stellen Sie detaillierte Anweisungen für bestimmte Aufgaben bereit, damit Benutzer die Funktionen Ihres Produkts effizient nutzen und erkunden können. |
Häufig gestellte Fragen | Beantworten Sie häufig gestellte Fragen in jeder Phase der User Journey, helfen Sie Benutzern, schnelle Antworten zu finden und Supportanfragen zu reduzieren. |
Richtlinien und Verfahren | Skizzieren Sie wichtige Organisationsprotokolle, die den Benutzern helfen, Unternehmensrichtlinien effektiv zu verstehen und einzuhalten. |
Vorlagen für Software/Technische Dokumentation
Wenn Sie in Schritt 3 Software/Technische Dokumentation ausgewählt haben, können Sie zwei beliebige Vorlagen aus der Liste unten auswählen.
Schablone | Zweck |
Versionshinweise | Halten Sie Benutzer über Updates, neue Funktionen, Fehlerbehebungen und Verbesserungen mit jeder Softwareversion auf dem Laufenden. |
Software-Design-Dokumentation (SDD) | Skizzieren Sie die Softwarearchitektur und das Design, einschließlich Diagrammen und Spezifikationen für die Entwicklungsanleitung. |
Dokumentation zu Softwareanforderungen | Beschreiben Sie den Zweck, die Funktionalitäten und die Umgebung der Software, um sicherzustellen, dass die Entwicklung mit den Projektzielen übereinstimmt. |
Dokumentation der Produktanforderungen (PRD) | Definieren Sie den Zweck, den Wert und die Funktionalitäten des Produkts, um die Bedürfnisse der Benutzer und die Geschäftsziele zu erfüllen. |
Prozessdokumentation | Detaillierte Schritte und Verfahren bei der Softwareentwicklung, um Arbeitsabläufe zu standardisieren und die Effizienz zu steigern. |
Benutzerhandbuch | Geben Sie umfassende Anweisungen zur Verwendung Ihres Produkts, die alle Funktionen und Funktionen abdecken. |
SOP-Dokumentationsvorlagen
Wenn Sie in Schritt 3 die SOP-Dokumentation ausgewählt haben, können Sie Vorlagen aus der Liste unten auswählen.
Schablone | Zweck |
Compliance-Richtlinien und -Verfahren | Stellen Sie sicher, dass Ihr Unternehmen die gesetzlichen Anforderungen erfüllt, indem Sie Richtlinien dokumentieren, die die Einhaltung von Vorschriften durchsetzen. |
Funktionsweise SOP | Steigern Sie die Effizienz und Produktivität, indem Sie die Betriebsabläufe in Ihrem Unternehmen standardisieren. |
Vorlagen für Benutzerhandbücher
Wenn Sie in Schritt 3 das Benutzerhandbuch ausgewählt haben, können Sie zwei beliebige Vorlagen aus der folgenden Liste auswählen.
Schablone | Zweck |
Installationsanleitung | Bietet alle notwendigen Einrichtungsinformationen, einschließlich Produktübersicht, Spezifikationen und Montageanleitungen, um einen reibungslosen Start mit der Wissensdatenbank-Plattform zu gewährleisten. |
Bedienungsanleitung | Bietet Schritt-für-Schritt-Montage- und Gebrauchsanleitungen mit Diagrammen und Sicherheitswarnungen, ideal für eine präzise Einrichtung und Sicherheitswarnungen für den ordnungsgemäßen Gebrauch. |
Wartungshandbuch | Stellen Sie detaillierte Anweisungen für die regelmäßige Wartung, Fehlerbehebung und Reparatur bereit, um eine optimale Leistung zu gewährleisten. |
Schulungshandbuch | Bietet umfassende Anleitungen zu Installation, Betrieb und Fehlerbehebung sowie Unterstützung für Benutzerschulungen und effektive Plattformnutzung. |
Bedienungsanleitung | Stellen Sie detaillierte Anweisungen für die tägliche Wartung und Fehlerbehebung bereit, um eine kontinuierliche effektive Verwaltung der Knowledge Base-Plattform zu gewährleisten. |
Personalisieren Sie Ihre Wissensdatenbank
Geben Sie die URL Ihres Unternehmens ein. Document360 analysiert Ihre Website und verwendet KI, um relevante Inhalte, Branding-Elemente und strukturierte Dokumentation zu generieren.
Wenn Sie diesen Schritt überspringen möchten, wird die Domain standardmäßig auf die Domain gesetzt, die mit Ihrer Registrierungs-E-Mail verknüpft ist.
Marken-Richtlinien
Ihr Projektname, Ihre Standardsprache, Ihr Branding-Logo und Ihre Markenfarben werden automatisch basierend auf der von Ihnen angegebenen URL festgelegt. Sie können die Felder jedoch bei Bedarf bearbeiten.
Die Spracheinstellungen Ihres Browsers bestimmen die Standardsprache. Englisch wird standardmäßig ausgewählt, wenn andere Sprachen die Sprache Ihres Browsers nicht unterstützen.
ANMERKUNG
Wenn Sie Spanisch oder brasilianisches Portugiesisch als Standardsprache auswählen; Die Sprache des Portals wird auf Spanisch oder brasilianisches Portugiesisch eingestellt. Andernfalls ist Englisch die Standardsprache.
Das Branding-Logo und die Primär-/Sekundärfarben werden von Ihrer Website extrahiert. Wenn Sie sich dafür entscheiden, diesen Schritt zu überspringen , wird der Projektname aus Ihrer Registrierungs-E-Mail abgeleitet und das Standardlogo und die Standardfarben von Document360 werden angewendet.
Sie können eine Vorschau Ihrer Wissensdatenbank-Site auf der rechten Seite des Bildschirms anzeigen.
Festlegen des Datenschutzes für die Dokumentation
Wählen Sie die gewünschten Datenschutzeinstellungen für Ihre Website aus:
Privat: Beschränken Sie den Zugriff auf die Wissensdatenbank, sodass nur Teamkonten den Inhalt anzeigen und mit ihm interagieren können, um ihn sicher und intern zu halten.
Öffentlich: Machen Sie die Wissensdatenbank für alle, auch für externe Benutzer, zugänglich, um einen offenen Zugang zu allen Inhalten zu ermöglichen.
Gemischt: Kombinieren Sie privaten und öffentlichen Zugriff, indem Sie zulassen, dass einige Abschnitte 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 auf das Document360-Wissensdatenbank-Portal
Sobald Sie die Einrichtung abgeschlossen haben, rufen Sie das Document360-Wissensdatenbank-Portal auf.
Für Benutzer, die die Wissensdatenbank-Plattform, die Software-Dokumentation/Technische Dokumentation, die SOP-Dokumentation oder das Benutzerhandbuch als Anwendungsfall ausgewä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 die von Ihnen gewählte Sprache von Eddy AI unterstützt wird, wird Ihre Dokumentation in dieser Sprache generiert. Ist dies nicht der Fall, wird standardmäßig Englisch verwendet. Wenn in der angegebenen URL kein relevanter Inhalt gefunden wird, sehen Sie vorinstallierte Artikel, die auf dem von Ihnen ausgewählten Anwendungsfall und den ausgewählten Vorlagen basieren, was Ihnen einen Vorsprung bei der Erstellung Ihrer Inhalte verschafft.
ANMERKUNG
Artikel, die von Eddy AI generiert werden, werden veröffentlicht und dann in den Entwurfsmodus versetzt. Sie können die Artikel nach Bedarf aktualisieren.
Für Benutzer, die den Anwendungsfall API-Dokumentation ausgewählt haben: Sie werden zum Arbeitsbereich API-Dokumentation weitergeleitet, wobei:
Sie sehen die API-Referenz der API-Spezifikation, die Sie während des Onboardings angegeben haben.
Wenn Sie keine API-Spezifikation angegeben haben, ist eine Beispiel-API-Referenz (Tierhandlungen-API) verfügbar.
Wechseln zwischen Document360-Projekten
Nachdem Sie Ihre Projekte in Document360 erstellt haben, müssen Sie möglicherweise an mehreren Projekten arbeiten oder für verschiedene Aufgaben zwischen ihnen wechseln. Document360 bietet einen intuitiven Projektumschalter, mit dem Sie dies nahtlos verwalten können.
Es gibt zwei Möglichkeiten, Projekte über das Wissensdatenbank-Portal zu wechseln:
Verwenden des Dropdown-Menüs "Projekte"
Über das Dashboard "Projekte"
Wechseln von Projekten über das Dropdown-Menü "Projekte"
Klicken Sie in einem beliebigen Modul im Knowledge Base-Portal auf das Projekt-Dropdown-Menü oben links auf dem Bildschirm.
Sie können den "Projektnamen", "Site-Zugriff" (Öffentlich - , Privat - oder Gemischt ) und die Bezeichnung "Sandbox" anzeigen, wenn es sich um ein Sandbox-Projekt handelt.
Klicken Sie in der Liste auf das Projekt, das Sie anzeigen möchten.
Wechseln von Projekten über das Projekt-Dashboard
Klicken Sie oben links auf das Document360-Logo.
Sie werden auf die Seite "Meine Projekte" weitergeleitet.
Die Liste aller Projekte, die Ihrem Konto gehören oder mit ihm 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-Ablauf?
Ja, Document360 bietet mehrsprachigen Support für das Onboarding, einschließlich Sprachen wie Englisch, Spanisch, brasilianisches Portugiesisch, Deutsch und Schwedisch. Innerhalb des Document360-Portals ist die Sprachunterstützung derzeit jedoch auf Englisch, Spanisch und brasilianisches Portugiesisch beschränkt.
Kann ich das Erscheinungsbild und die Struktur meines Document360-Projekts anpassen?
Ja, Document360-Projekte bieten umfangreiche Anpassungsoptionen. Sie können das Erscheinungsbild Ihrer Wissensdatenbank anpassen, indem Sie Ihre Startseite und Designs entwerfen, das Branding Ihrer Organisation hinzufügen, editororientiert sind und Artikel in einer hierarchischen Struktur (Kategorien) organisieren, die Ihren Dokumentationsanforderungen entspricht.
Ist es möglich, den Zugriff und die Berechtigungen innerhalb von Document360-Projekten zu steuern?
Absolut. Document360 bietet robuste Zugriffskontrolle und Berechtigungseinstellungen. Sie können Teamkonten Rollen und Berechtigungen zuweisen und den Zugriff auf bestimmte Funktionen und Inhalte basierend auf ihren Zuständigkeiten und Anforderungen einschränken oder gewähren.
Wie hilft Document360 bei der Versionskontrolle und dem Dokumentationsverlauf?
Document360-Projekte verfügen über ein umfassendes System zur Versionskontrolle von Artikeln, das als "Artikelrevisionen" bezeichnet wird. Es speichert und verfolgt automatisch Änderungen an Artikeln, sodass Sie bei Bedarf zu früheren Versionen zurückkehren können. Dies stellt die Integrität Ihrer Dokumentation sicher und vereinfacht die Zusammenarbeit bei der Aktualisierung von Inhalten.
Woher weiß ich, an welchem Projekt ich gerade arbeite?
Sie können den Projektnamen überprüfen, der oben links auf dem Bildschirm im Knowledge Base-Portal angezeigt wird.
Was passiert, wenn ich das Projekt, zu dem ich wechseln möchte, nicht sehe?
Stellen Sie sicher, dass Sie über die erforderlichen Zugriffsberechtigungen für dieses Projekt verfügen. Wenn das Projekt immer noch nicht angezeigt wird, wenden Sie sich an Ihren Document360-Administrator, um Unterstützung zu erhalten.
Was ist ein "Sandbox"-Projekt und wie unterscheidet es sich von anderen Projekten?
Ein Sandbox-Projekt ist eine Testumgebung, in der Sie experimentieren können, ohne Ihre Live-Projekte zu beeinträchtigen. Es wird ein Label "Sandbox" in der Projekt-Dropdown-Liste haben.
Was bedeutet "Site Access" in der Dropdown-Liste des Projekts?
"Site-Zugriff" gibt an, ob es sich um ein öffentliches, privates oder gemischtes Projekt handelt. Dies definiert die Barrierefreiheit der Inhalte des Projekts.
Wie kann ich Zugriff auf ein Projekt anfordern, mit dem ich derzeit nicht verknüpft bin?
Wenden Sie sich an Ihren Teamadministrator oder Projektinhaber, um den Zugriff auf das gewünschte Projekt anzufordern.
Was passiert, wenn Eddy AI keine Inhalte von meiner Website für die Standardartikel generieren kann?
Wenn Eddy AI nicht in der Lage ist, genügend Inhalte von Ihrer Website zu extrahieren, verwendet das System Standardvorlagen, die auf dem von Ihnen ausgewählten Anwendungsfall basieren.