Wordpress plugin documentatie
Het is daarom ook aan te raden om - zelfs voor de kleinste plugins - een goede documentatie te schrijven voor de plugin, het gebruik hiervan en de installatie. Nu is het schrijven van een handleiding op diverse manieren mogelijk, maar toch resulteert dit vaak in een tè beknopt "readme" bestand, geschreven in kladblok. Wat uit onze ervaring echter blijkt, is dat het goed werkt om de gebruiker direct het gevoel te geven dat hij of zij beschikt over een plugin die tot in detail is uitgewerkt. Dit begint dus al bij de handleiding. Zorg dat de handleiding interactief overkomt, men snel naar diverse elementen kan "springen" zodat de informatie snel voor handen is. Het nadeel hiervan is dat je dan al snel een apart HTML bestand moet maken waarin die informatie te vinden is en dat is weer extra werk.Eenvoudiger dan je denkt
Het maken van een handleiding waarbij diverse elementen direct voor handen zijn, is simpeler dan veel mensen denken. Een erg goede en handige oplossing daarvoor is bijvoorbeeld "Documenter". Documenter kan gezien worden als een online programma waarbij elementen naar wens toe te voegen zijn, informatie bij de elementen geschreven kan worden en uiteraard afbeeldingen toegevoegd kunnen worden. Een extra handigheidje is dat documentatie opgeslagen kan worden (deze moet je wel lokaal op je computer opslaan) en de site beschikt over een auto-save (automatisch opslaan) functie. Valt de browser uit, klik je per ongeluk op een verkeerde knop of wat dan ook; je ingevoerde informatie kan gewoon terug gehaald worden. Ben je tevreden over de ingevoerde informatie, teksten, afbeeldingen en elementen? Dan kun je direct online het resultaat zien van de handleiding. Is ook dit naar tevredenheid? Dan kun je de gehele documentatie direct opslaan en bijvoegen bij je plugin.Resultaat
Het resultaat is een HTML-bestand waarin men naar de diverse elementen (hoofdstukken) kan springen. Je kunt hierbij denken aan bijvoorbeeld:- Inleiding
- Installatie
- Instellingen
- Thema instellingen
- Ondersteuning
Mensen die opzoek zijn naar thema oplossingen (zoals code verwerken in thema bestanden) kunnen direct naar het juiste element toe springen en vinden de informatie die zij zoeken. Bezoek de website van Documenter om meer informatie te vinden of direct aan de slag te gaan. Benieuwd naar WordPress plugins van Tussendoor internet & marketing? Klik hier.