Developer-oplossingen documenteren (FileMaker Pro Advanced)
U dient voor uw databaseoplossing documentatie beschikbaar te stellen, ongeacht of het om een database gaat die in FileMaker Pro of FileMaker Pro Advanced moet worden geopend of een autonome runtime-databaseoplossing. U kunt op verschillende manieren documentatie voor uw oplossing aanbieden, waaronder een gedrukte handleiding, een online Help-systeem en een
lay-out Over… die in de oplossing vanuit elke lay-out beschikbaar is.
Maak een eigen lay-out van het type Over… en Help waarin is gedocumenteerd wat uw databaseoplossing is, hoe deze moet worden gebruikt en waar gebruikers terechtkunnen voor meer informatie. Gebruik daarna de functie Eigen menu's om
scripts toe te voegen aan menuopdrachten die de lay-outs Over… en Help openen.
Opmerking Het Help-systeem van FileMaker Pro en FileMaker Pro Advanced is niet beschikbaar in runtime-toepassingen. Statusbalk-Help (Windows) en Help-tags (macOS) zijn echter wel beschikbaar.
Een lay-out van het type Over… maken
In de FileMaker Pro Advanced-licentie is vermeld dat u voor runtime-databaseoplossingen een lay-out van het type 'Over...' beschikbaar moet stellen, waarin uw gebruikers informatie kunnen vinden over hoe zij met u contact kunnen opnemen voor technische ondersteuning.
Zo maakt u een Over…-lay-out:
2. Typ bij Lay-outnaam de tekst Over <uw oplossing>.
3. Selecteer de optie Lege lay-out.
4. Klik op de knop Voltooien.
5. Voeg aan de lay-out uw logo, andere afbeeldingen en uw bedrijfsgegevens toe.
6. Vermeld een tekst die gebruikers waarschuwt of de oplossingsbestanden beveiligd zijn met wachtwoorden of dat volledige toegangsprivileges zijn verwijderd.
8. Maak een knop waarmee uw gebruikers naar de hoofdlay-out van het primaire bestand kunnen terugkeren.
9. Kies Scripts > Scriptwerkruimte en maak een script dat overschakelt naar de lay-out Over.
10. Vermeld het woord Over in de naam van het script.
Zo geeft u de Over…-lay-out weer wanneer de runtime-toepassing wordt gestart:
1. Open het primaire bestand voor de databaseoplossing.
2. Kies Bestand > Bestandsopties.
3. Selecteer op het tabblad Openen van het dialoogvenster Bestandsopties de optie Naar lay-out gaan en selecteer de lay-out Over… in de lijst.
Een eigen lay-out van het type Help maken
Maak een Help-lay-out waarin u het gebruik van uw oplossing toelicht en voeg er gegevens aan toe. Maak daarna in het primaire bestand van uw oplossing een script dat het Help-systeem weergeeft. Gebruik de functie Eigen menu's om het script beschikbaar te stellen als een opdracht in het menu Help.
Als u een webpagina wilt maken om uw oplossing te documenteren, kunt u in uw Help-lay-out een Web Viewer plaatsen waarin die webpagina kan worden geopend.
Gedrukte documentatie meeleveren
U dient aan uw gebruikers instructies over de installatie van uw databaseoplossing beschikbaar te stellen. Deze informatie moet u zeker in uw documentatie vermelden:
•Minimumvereisten voor apparatuur en software
•hoe moet uw gebundelde oplossing worden geïnstalleerd?
•hoe moeten eigen bestanden worden geïnstalleerd?
•De werking van software die u mogelijk hebt toegevoegd voor:
•De installatie van uw gebundelde oplossing
•Het decomprimeren van uw oplossingsbestanden
•Hoe werkt uw Help-systeem?
•Hoe kunnen de gebruikers met u contact opnemen voor technische ondersteuning?
Belangrijk Zorg ervoor dat wanneer de bestanden van uw runtime-databaseoplossing beschadigd zouden raken, uw gebruikers het e-mailadres en telefoonnummer van uw technische ondersteuning kunnen terugvinden in uw gedrukte documentatie of in een tekstbestand. Als een databasebestand beschadigd raakt, is het mogelijk dat ze geen toegang meer hebben tot de Over…-lay-out in uw oplossing waarin uw contactgegevens zijn vermeld.
Het is ook aangewezen om de volgende aanbevelingen te vermelden:
•Meld uw gebruikers dat de namen van uw oplossingsbestanden niet mogen worden gewijzigd (met uitzondering van de runtime-toepassing) omdat ze uw oplossing anders mogelijk niet kunnen uitvoeren.
•Beveel uw gebruikers aan om regelmatig een reservekopie van hun gegevens te maken. U kunt bijvoorbeeld een deel van dat proces automatiseren door scripts toe te voegen die een kopie van de oplossingsbestanden opslaan. Raadpleeg
FileMaker Pro-databases onderhouden en herstellen.
Verwante onderwerpen