Interne documentatie - overzicht

Met de functie Interne documentatie kunt u uw eigen documentatie (tekst of URL) toevoegen aan de bestaande online Help.

Gebruikers kunnen deze documentatie openen door in het betreffende productgebied op de knop Help te klikken. In de Help van het product staat onder de kop Interne documentatie een koppeling naar een pagina waarop uw documentatie wordt weergegeven.

U maakt de interne documentatie in het deelvenster Interne documentatie van de module Beheerder. Voor meer informatie, zie Deelvenster Interne documentatie.

Voorbeeld:

Jan is een Release Control-beheerder in organisatie ABC. Suzan, de webbeheerder, vertelt Jan dat ze elke maandag onderhoud aan de website pleegt en vraagt hem om in Release Control een tijdsperiodecategorie te maken die voorkomt dat mensen op maandagen wijzigingen in de website van het bedrijf aanbrengen.

Jan maakt een tijdsperiodecategorie met de naam Web_blackout. Wanneer gebruikers van Release Control naar de module Analyse gaan en het tabblad Beoordeling > Conflicten met tijdsperiode openen, kan het gebeuren dat hun geplande wijziging in conflict is met de periode Web_blackout. Jan wil gebruikers uitleggen wat de functie van deze tijdsperiodecategorie is en besluit om een intern document te schrijven.

Hij opent het deelvenster Interne documentatie (Module > Beheerder > tabblad Configuratie > Interne documentatie), selecteert Conflicten met tijdsperiode in het deelvenster Productgebied en voegt de documentatie toe door de gewenste velden in te vullen en de wijzigingen op te slaan:

Als gebruikers op de koppeling klikken, wordt er een aparte pagina geopend met de content die Jan heeft toegevoegd. Jan had ook kunnen beslissen om informatie over de tijdsperiode op de interne bedrijfswebsite te publiceren. In plaats van tekst invoeren in het deelvenster Interne documentatie had hij dan een URL kunnen opgeven. In dat geval zou de koppeling direct de URL hebben geopend.