My wiki:Over
IMK Portal Wiki
Samenvatting
- Legt uit hoe de IMK Portal Wiki is opgebouwd en hoe je informatie terugvindt.
- Beschrijft de indeling in hoofdpagina, rolpagina's, modulepagina's en begrippen.
- Biedt richtlijnen voor navigatie, naamgeving en schrijfwijze.
Doel van deze wiki
De IMK Portal Wiki beschrijft het gebruik van het IMK Portal in combinatie met ThinkOut. De wiki ondersteunt:
- ondernemers bij inzicht, planning en gebruik van het portaal;
- adviseurs bij analyse, beoordeling en levensvatbaarheidsonderzoek;
- interne redacteuren bij het eenduidig vastleggen en bijwerken van instructies.
De nadruk ligt op korte, stapsgewijze instructies en duidelijke verwijzingen tussen onderdelen.
Doelgroepen
Deze wiki is primair bedoeld voor:
- Ondernemers: gebruikers van het IMK Portal die hun eigen cijfers willen begrijpen en plannen.
- Adviseurs: IMK adviseurs, externe adviseurs, accountants, budgetcoaches en andere professionals.
- Redacteuren: medewerkers die de wiki aanvullen en onderhouden.
Voor ondernemers en adviseurs zijn aparte rolpagina's ingericht. Redacteuren gebruiken deze pagina als toelichting op de structuur.
Structuur op hoofdlijnen
De wiki kent vier hoofdtypen pagina's.
1. Hoofdpagina
- IMK Portal in combinatie met ThinkOut is de centrale ingang.
- De hoofdpagina biedt:
- een korte uitleg over IMK Portal en ThinkOut;
- een keuze op rol: IMK Portal voor ondernemers en IMK Portal voor adviseurs;
- een overzicht van de belangrijkste modules, zoals Dashboard, Cashflow, Budgetten en Scenario's.
- Bovenaan staat {{DirectNaar}} voor snelle toegang.
2. Rolpagina's (route per gebruiker)
- IMK Portal voor ondernemers (hoofdstuk 3).
- IMK Portal voor adviseurs (hoofdstuk 4).
Kenmerken van rolpagina's:
- Beschrijven de werkstroom vanuit de rol: welke stappen doorloopt de gebruiker.
- Verwijzen naar modulepagina's voor detailuitleg.
- Gebruiken een sectie Op deze pagina voor navigatie binnen het hoofdstuk.
- Houden beschrijvingen kort en taakgericht, in gebiedende wijs.
3. Modulepagina's (schermen en functies)
Voor elk belangrijk scherm of functie is er een eigen modulepagina, onder andere:
Kenmerken van modulepagina's:
- Leggen één scherm of module volledig uit: velden, knoppen, filters en acties.
- Gebruiken {{DirectNaar}} en een {{Samenvatting}} bovenaan.
- Hebben een vaste opbouw met:
- Op deze pagina (lokale navigatie);
- secties per onderdeel (bijvoorbeeld filters, acties, configuratie);
- Zie ook met links naar rol- en begrippenpagina's.
4. Begrippenpagina's (kernbegrippen)
Voor belangrijke begrippen zijn aparte pagina's ingericht, zoals:
Kenmerken van begrippenpagina's:
- Geven een korte definitie in gewone taal.
- Leggen uit waar het begrip in het IMK Portal terugkomt.
- Beschrijven waarom het begrip belangrijk is voor inzicht en beoordeling.
- Bevatten een blok In de praktijk met deeplinks naar relevante secties op de rolpagina's.
- Eindigen met Zie ook met verwijzingen naar modules en rolpagina's.
Navigatiepatronen
Direct naar
- Sjabloon {{DirectNaar}} staat bovenaan module- en hoofdpagina's.
- Het sjabloon bevat links naar de belangrijkste toepassingen van het portaal, zoals:
Doel: op iedere pagina snel kunnen springen naar de meest gebruikte onderdelen.
Op deze pagina
- Bovenaan langere rol- en modulepagina's staat een sectie Op deze pagina met een lijst interne links.
- De links verwijzen naar koppen en ankers op dezelfde pagina.
- Dit helpt gebruikers om binnen één pagina direct naar de juiste paragraaf te gaan.
In de praktijk
- Begrippenpagina's bevatten een sectie In de praktijk met deeplinks naar rolpagina's.
- De sectie heeft twee vaste blokken:
- Voor ondernemers met links naar relevante paragrafen op IMK Portal voor ondernemers.
- Voor adviseurs met links naar relevante paragrafen op IMK Portal voor adviseurs.
Doel: de stap van definitie naar praktische toepassing zo klein mogelijk maken.
Zie ook
- Elke pagina sluit af met Zie ook.
- Deze sectie verwijst naar:
- gerelateerde begrippen;
- relevante modules;
- de twee rolpagina's.
Doel: gebruikers altijd een logische vervolgstap bieden.
Naamgeving en ankers
Paginanamen
- Modulenaam = naam van het scherm of de functie:
- Begrippen = enkelvoud (m.u.v. kasstromen):
- Rolpagina's:
Ankers binnen pagina's
- Lange hoofdstukken gebruiken ankers om intern te verwijzen.
- Ankers kunnen automatisch uit de kop ontstaan of expliciet worden geplaatst met bijvoorbeeld:
<span id="dashboard"></span>
- Links naar ankers gebruiken het patroon:
[[#dashboard|Dashboard]] (op dezelfde pagina) of [[IMK Portal voor ondernemers#dashboard|Dashboard voor ondernemers]] (vanaf een andere pagina).
Schrijfstijl en scope
Schrijfstijl
- Gebruik gebiedende wijs: Klik op, Ga naar, Selecteer.
- Gebruik korte zinnen en één handeling per stap.
- Vermijd jargon waar mogelijk; leg technische termen toe op begrippenpagina's.
- Gebruik waar passend dezelfde termen als in het portaal (knoppen, veldnamen, tabbladen).
Scope
- Rolpagina's:
- beschrijven de route per rol en verwijzen naar modules.
- Modulepagina's:
- beschrijven schermen, opties en acties volledig.
- Begrippenpagina's:
- geven definities en duiden het belang.
Verdiepende context (normen, levensvatbaarheidsmethodiek) komt alleen aan bod waar direct relevant voor het gebruik.
Uitbreiding en onderhoud
Bij nieuwe functionaliteit:
- Bepaal of het om een rolspecifiek proces, een nieuw scherm of een nieuw begrip gaat.
- Voeg indien nodig:
- een paragraaf toe op de relevante rolpagina;
- een nieuwe modulepagina toe voor het scherm;
- een nieuwe begrippenpagina toe voor de definitie.
- Werk {{DirectNaar}}, Op deze pagina en Zie ook bij zodat de navigatie klopt.
- Controleer of deeplinks in In de praktijk nog juist zijn.
Gebruik deze pagina als referentie bij het uitbreiden of herstructureren van de IMK Portal Wiki.