Abonnementen die deze functie ondersteunen: Professional Business Enterprise
Een project in Document360 dient als een uitgebreid platform voor al uw documentatiebehoeften. Het bevat je artikelen, categorieën, subcategorieën, startpagina, teamaccounts, lezers en groepen (voor privé- en gemengde projecten), en aangepaste configuraties of instellingen. Deze gecentraliseerde aanpak zorgt ervoor dat je kennisbank georganiseerd, gemakkelijk toegankelijk en schaalbaar is.
Hoe maak je een kennisbasisproject in Document360?
Document360-projecten zijn ontworpen om je documentatieproces te stroomlijnen en bieden een gestructureerde en efficiënte manier om je informatie te beheren. Of je nu gebruikershandleidingen, interne procesdocumenten of documentatie maakt, een Document360-project biedt het kader om content effectief op te slaan, beheren en distribueren. Volg deze stappen om je kennisbasisproject samen te stellen.
Toegang tot het dashboard
Log in op het Document360-portaal met je account om toegang te krijgen tot het Dashboard.
Als je bent ingelogd en je bevindt je in het Knowledge Base-portaal van een ander project, klik dan op het Document360-icoon in de bovenste navigatiebalk om doorgestuurd te worden naar het Dashboard.Klik op de +Project rechtsboven om een nieuw project aan te maken.
Kies je use case
Selecteer uw primaire gebruikssituatie voor Document360 door op 'Aan de slag' te klikken.
Gebruikssituatie | Beschrijving |
|---|---|
Kennisbankplatform | Je kunt een centrale hub creëren waar alle kennis en middelen van je team worden opgeslagen. Het helpt je team snel antwoorden te vinden en verbetert de zelfservice van de klant door hen gemakkelijk toegang te geven tot de informatie die ze nodig hebben. |
Softwaredocumentatie/Technische documentatie | Je kunt al je software of technische documentatie efficiënt organiseren en onderhouden. Het helpt je team om productkenmerken, API's, release notes en meer te documenteren, zodat ontwikkelaars en gebruikers duidelijke en actuele informatie hebben. |
SOP-documentatie | Je kunt gedetailleerde SOP's maken die je team consequent kan volgen. Het zorgt ervoor dat iedereen dezelfde processen volgt, vermindert fouten en faciliteert de onboarding van nieuwe medewerkers door hen duidelijke procedurele richtlijnen te geven. |
Gebruikershandleiding | Je kunt uitgebreide gebruikershandleidingen ontwikkelen die je klanten of teamleden begeleiden bij de functies en het gebruik van je product. Het helpt bij het verminderen van supportvragen door stapsgewijze instructies en tips voor probleemoplossing te bieden. |
API-documentatie | Documenteer gedetailleerde informatie over API-eindpunten, verzoek- en responsformaten, authenticatiemethoden en voorbeelden. Dit zorgt ervoor dat ontwikkelaars een duidelijk begrip hebben van hoe ze kunnen integreren met je API's. Door deze optie te selecteren, word je doorgestuurd naar de API-setupflow. |
Overigen | Kies deze optie als jouw use case niet binnen de vooraf gedefinieerde categorieën valt. Je kunt je kennisbasis aanpassen op basis van specifieke organisatorische of projectbehoeften. |
Selecteer een sjabloon
Selecteer het type content dat je in je Document360-project wilt maken. Je kunt tot twee sjablonen kiezen die bij jouw behoeften passen.
OPMERKING
Op basis van je keuze worden deze sjablonen tijdens het maken in je project ingebed. Je keuze beperkt je echter niet in het gebruik van andere functies of het maken van verschillende soorten content.
Als je API-documentatie als use case hebt geselecteerd, sla je deze stap over en word je doorgestuurd naar de API-instelling .
Templates voor kennisbasisplatforms
Als je het Knowledge Base-platform in stap 3 hebt geselecteerd, kun je twee templates uit de onderstaande lijst kiezen.
Sjabloon | Doel |
|---|---|
Gidsen voor het begin | Help nieuwe gebruikers je product snel te begrijpen en te beginnen met gebruiken met duidelijke, stapsgewijze instructies. Dit zorgt voor een soepele onboarding-ervaring. |
Instructiegidsen | Geef gedetailleerde instructies voor specifieke taken, zodat gebruikers de functies van je product efficiënt kunnen benutten en verkennen. |
Veelgestelde vragen | Beantwoord veelgestelde vragen in elke fase van de gebruikersreis, zodat gebruikers snel antwoorden vinden en ondersteuningsvragen worden verminderd. |
Beleid & procedures | Stel essentiële organisatorische protocollen uiteen, zodat gebruikers de bedrijfsrichtlijnen effectief begrijpen en naleven. |
Software-/technische documentatietemplates
Als je in stap 3 de software-/technische documentatie hebt geselecteerd, kun je twee templates uit de onderstaande lijst kiezen.
Sjabloon | Doel |
|---|---|
Uitgavenotities | Houd gebruikers op de hoogte van updates, nieuwe functies, bugfixes en verbeteringen bij elke softwarerelease. |
Software Design Documentatie (SDD) | Geef een schets van softwarearchitectuur en ontwerp, inclusief diagrammen en specificaties voor ontwikkelingsrichtlijnen. |
Documentatie van softwarevereisten | Beschrijf het doel, de functionaliteiten en de omgeving van de software om ervoor te zorgen dat de ontwikkeling aansluit bij de projectdoelen. |
Productvereistendocumentatie (PRD) | Definieer het doel, de waarde en de functionaliteiten van het product om te voldoen aan de behoeften van gebruikers en bedrijfsdoelstellingen. |
Procesdocumentatie | Gedetailleerde stappen en procedures bij softwareontwikkeling om workflows te standaardiseren en de efficiëntie te verhogen. |
Gebruikershandleiding | Geef uitgebreide instructies over het gebruik van je product, inclusief alle functies en functies. |
SOP-documentatietemplates
Als je in stap 3 de SOP-documentatie hebt geselecteerd, kun je sjablonen kiezen uit de onderstaande lijst.
Sjabloon | Doel |
|---|---|
Nalevingsbeleid en -procedures | Zorg ervoor dat uw organisatie voldoet aan de wettelijke vereisten door beleid te documenteren dat naleving afdwingt. |
Operatie SOP | Verhoog de efficiëntie en productiviteit door operationele procedures binnen uw organisatie te standaardiseren. |
Gebruikshandleidingsjablonen
Als je de gebruikershandleiding in stap 3 hebt geselecteerd, kun je twee templates uit de onderstaande lijst kiezen.
Sjabloon | Doel |
|---|---|
Installatiehandleiding | Biedt alle benodigde installatie-informatie, inclusief productoverzicht, specificaties en assemblage-instructies, zodat het kennisbankplatform soepel begint. |
Handleiding | Biedt stapsgewijze montage- en gebruiksinstructies met diagrammen en veiligheidswaarschuwingen, ideaal voor nauwkeurige installatie en veiligheidswaarschuwingen voor correct gebruik. |
Onderhoudshandleiding | Geef gedetailleerde instructies voor regelmatig onderhoud, probleemoplossing en reparatieprocedures om optimale prestaties te garanderen. |
Trainingshandleiding | Biedt uitgebreide begeleiding over installatie, werking en probleemoplossing, en ondersteuning voor gebruikerstraining en effectief platformgebruik. |
Bedieningshandleiding | Geef gedetailleerde instructies voor dagelijks onderhoud en probleemoplossing, zodat het Knowledge Base-platform continu en effectief beheer wordt gegarandeerd. |
Personaliseer je kennisbasis
Voer de URL van je bedrijf in. Document360 zal je site analyseren en AI gebruiken om relevante content, brandingelementen en gestructureerde documentatie te genereren.
Als je deze stap wilt overslaan, wordt het domein standaard het domein dat aan je registratie-e-mail is gekoppeld.
Merkrichtlijnen
Je projectnaam, standaardtaal, brandinglogo en merkkleuren worden automatisch ingesteld op basis van de door je opgegeven URL. Je kunt de velden echter aanpassen indien nodig.
De taalinstellingen van je browser bepalen de standaardtaal. Engels wordt standaard geselecteerd als andere talen de taal van je browser niet ondersteunen.
OPMERKING
Als je Spaans of Braziliaans Portugees als standaardtaal kiest; de portaaltaal zal worden ingesteld op Spaans of Braziliaans Portugees. Anders wordt Engels de standaardtaal.
Het brandinglogo en de primaire en secundaire kleuren worden van je website gehaald. Als je ervoor kiest deze stap over te slaan , wordt de projectnaam afgeleid van je registratie-e-mail, en worden het standaardlogo en de kleuren van Document360 toegepast.
Je kunt je Knowledge Base-site aan de rechterkant van het scherm bekijken.
Stel privacy van documentatie in
Kies de gewenste privacy-instellingen voor je site:
Privé: Beperk de toegang tot de kennisbank zodat alleen teamaccounts de inhoud kunnen bekijken en ermee kunnen interageren, zodat deze veilig en intern blijft.
Openbaar: Maak de kennisbank toegankelijk voor iedereen, inclusief externe gebruikers, zodat alle inhoud open toegankelijk is.
Gemengd: Combineer privé- en publieke toegang door sommige delen van de kennisbasis zichtbaar te maken voor het publiek, terwijl andere secties beperkt blijven tot teamaccounts.
Klik op Volgende om verder te gaan.
Toegang tot het Document360 Knowledge Base-portaal
Zodra je de setup hebt voltooid, ga je naar het Document360 Knowledge Base-portaal.
Voor gebruikers die als gebruiksgeval Knowledge Base platform, softwaredocumentatie/technische documentatie, SOP-documentatie of gebruikershandleiding hebben gekozen: Document360 genereert automatisch relevante artikelen en categorieën op basis van de geselecteerde use cases en de inhoud van uw website. Elke categorie bevat minstens 2-3 door AI gegenereerde artikelen, en indien nodig worden subcategorieën aangemaakt. Als je gekozen taal wordt ondersteund door Eddy AI, wordt je documentatie in die taal gegenereerd. Zo niet, dan wordt het standaard Engels. Als er geen relevante inhoud wordt gevonden in de verstrekte URL, zie je vooraf geladen artikelen gebaseerd op je gekozen use case en sjablonen, wat je een voorsprong geeft bij het maken van je content.
OPMERKING
Artikelen die door Eddy AI worden gegenereerd, worden gepubliceerd en vervolgens in conceptmodus gezet. Je kunt de artikelen indien nodig bijwerken.
Voor gebruikers die de API-documentatie gebruikscase hebben gekozen: Je wordt doorgestuurd naar het API-documentatiewerkgebied, waar:
Je ziet de API-referentie van de API-specificatie die je tijdens de onboarding hebt opgegeven.
Als je geen API-specificatie hebt opgegeven, is er een voorbeeldreferentie van de API (Pet store API) beschikbaar.
Schakelen tussen Document360-projecten
Zodra je je projecten in Document360 hebt aangemaakt, moet je mogelijk aan meerdere projecten werken of tussen ze wisselen voor verschillende taken. Document360 biedt een intuïtieve projectswitcher om je te helpen dit naadloos te beheren.
Er zijn twee manieren om van project te wisselen vanuit het Knowledge Base-portaal:
Gebruik van het dropdown Projecten.
Vanuit het Projecten-dashboard
Projecten wisselen met behulp van het Projecten-dropdown
Klik vanuit elke module in het Knowledge Base-portaal op het project-dropdown in de bovenste navigatiebalk.
Je kunt de "Projectnaam," "Site Access" (Publiek - , Privé - , , of Gemengd ) en een "Sandbox"-label bekijken als het een Sandbox-project is.
Klik op het project dat je wilt bekijken uit de lijst.
Projecten wisselen vanaf het Projects-dashboard
Klik op het Document360-logo in de bovenste navigatiebalk.
Je wordt doorgestuurd naar de pagina Your projects .
De lijst van alle projecten die eigendom zijn van of aan je account gekoppeld zijn, wordt weergegeven.
Klik op het project waar je naartoe wilt navigeren.
FAQ
Ondersteunt Document360 verschillende talen in de onboardingflow?
Ja, Document360 biedt meertalige ondersteuning in het onboardingproces, inclusief talen als Engels, Spaans, Braziliaans Portugees, Duits en Zweeds. Binnen het Document360-portaal is de taalondersteuning momenteel beperkt tot Engels, Spaans en Braziliaans Portugees.
Kan ik het uiterlijk en de structuur van mijn Document360-project aanpassen?
Ja, Document360-projecten bieden uitgebreide aanpassingsmogelijkheden. Je kunt het uiterlijk en de sfeer van je kennisbank aanpassen door je homepage, thema's te ontwerpen, de branding van je organisatie toe te voegen, gericht op redacteuren te zijn, en artikelen te organiseren in een hiërarchische structuur (categorieën) die past bij je documentatiebehoeften.
Is het mogelijk om toegang en rechten binnen Document360-projecten te controleren?
Absoluut. Document360 biedt robuuste toegangscontrole en machtigingsinstellingen. Je kunt rollen en rechten toewijzen aan teamaccounts, waarbij je specifieke functies en content beperkt of toegang geeft op basis van hun verantwoordelijkheden en vereisten.
Hoe helpt Document360 met versiebeheer en documentatiegeschiedenis?
Document360-projecten onderhouden een uitgebreid versiebeheersysteem voor artikelen, aangeduid als "Artikelrevisies". Het slaat automatisch wijzigingen op en volgt wijzigingen in artikelen, zodat je indien nodig terug kunt gaan naar eerdere versies. Dit waarborgt de integriteit van uw documentatie en vereenvoudigt samenwerking bij contentupdates.
Hoe weet ik aan welk project ik momenteel werk?
Je kunt de projectnaam bekijken die wordt weergegeven in de bovenste navigatiebalk van het Knowledge Base-portaal.
Wat gebeurt er als ik het project waar ik naartoe wil overstappen niet zie?
Zorg ervoor dat je de benodigde toegangsrechten voor dat project hebt. Als het project nog steeds niet verschijnt, neem dan contact op met je Document360-beheerder voor hulp.
Wat is een "Sandbox"-project en hoe verschilt het van andere projecten?
Een Sandbox-project is een testomgeving waarin je kunt experimenteren zonder invloed te hebben op je live projecten. Het zal een "Sandbox"-label in het project-dropdown hebben.
Wat betekent "Site Access" in het projectkeuzemenu?
"Site Access" geeft aan of het project Openbaar, Privé of Gemengd is. Dit bepaalt het toegankelijkheidsniveau van de inhoud van het project.
Hoe kan ik toegang aanvragen tot een project waar ik momenteel niet aan verbonden ben?
Neem contact op met je teambeheerder of projecteigenaar om toegang tot het gewenste project aan te vragen.
Wat gebeurt er als Eddy AI geen content kan genereren vanaf mijn website voor de standaardartikelen?
Als Eddy AI niet voldoende content van je website kan halen, gebruikt het systeem standaard sjablonen op basis van je gekozen gebruikssituatie.
Hoeveel projecten kan ik aanmaken in Document360?
Je kunt zoveel projecten maken als je wilt in Document360. Elk nieuw project wordt geleverd met een gratis proefperiode van 14 dagen, waarna je een apart abonnement voor dat project moet afsluiten.
Waarom kan ik de site-zichtbaarheid voor mijn proefproject niet veranderen?
Standaard zijn alle proefprojecten in Document360 ingesteld op Privé om je content tijdens de evaluatie te beschermen en onbedoelde blootstelling te voorkomen. Je zult merken dat de opties Gemengde en Publieke zichtbaarheid zijn uitgeschakeld (grijs) in zowel het onboardingscherm als de pagina met Site-toeganginstellingen .
Als je de zichtbaarheid van je proefproject wilt veranderen:
Klik op de Link Contact Sales die in de infobanner wordt weergegeven.
Dit zal een geautomatiseerde e-mailverzoek naar ons verkoopteam met uw projectgegevens triggeren.
Zodra je verzoek is gevalideerd, stuurt het verkoopteam een bevestigingsmail.
Je kunt dan de zichtbaarheid van je project wijzigen naar Gemengd of Publiek vanaf de Site-toegangsinstellingenpagina .
OPMERKING
Deze beperking zorgt ervoor dat je project veilig blijft totdat je klaar bent om het openbaar toegankelijk te maken.