SchuldhulpHulp:Stijlgids

Uit SchuldhulpHulp
Versie door DJB (overleg | bijdragen) op 18 apr 2021 om 08:43 (→‎Te bespreken...)
(wijz) ← Oudere versie | Huidige versie (wijz) | Nieuwere versie → (wijz)
Naar navigatie springen Naar zoeken springen

Bij de start van de kennisbank is stilgestaan bij de taal en indeling van de pagina's. Naarmate de omvang toenam is daaruit een vorm ontstaan die gebruikt wordt bij de pagina's. Dat is geen wet van meden en perzen en is nog dagelijks aan inzichten en wijzigingen onderhevig. Hieronder staat de samenvatting van uitgangspunten die natuurlijk op basis van ervaring en wederom inzicht kan worden aangepast:

Namen onderdeel pagina

In onderstaande pagina staat de benaming van de structuur van een kennisbankpagina:

paginastructuur

Als aanvulling hierop nog de term pagina of artikel. Beiden zijn synoniemen voor hetzelfde.

Aanspreekstijl

Uitgangspunt is dat je schrijft zoals je de lezer in het dagelijks verkeer zou aanspreken. Vandaar dat de "Je" vorm wordt gebruikt.

Omvang artikelen

De kennisbank heeft niet tot doel alle situaties te beschrijven maar de meest voorkomende. In artikelen komt dit tot uiting door de stelregel dat de tekst 80% van de gangbare situaties beschrijft en voor uitzonderingen of bijzonderheden doorverwijst naar een betrouwbare externe pagina. Hierbij geldt als uitgangspunt dat het lezen van een pagina maximaal 5 minuten mag duren. Dit laatste kan leiden om een onderwerp en subonderwerp in twee pagina's te hakken.

Inhoud artikelen

Uitgangspunt is dat de inhoud van de tekst afhankelijk is van de inhoud van een pagina waarnaar wordt doorverwezen. Is de uitleg op de externe pagina onvoldoende duidelijk dan is er meer tekst nodig op de kennisbankpagina en omgekeerd, Basis is dat de kennisbank ten minste een inleidende tekst bevat die de 80% regel omvat. Feitelijk... na lezing weet je in algemene zin wat een onderwerp inhoudt.

Doorverwijzingen

Zoveel mogelijk dient herhaling van teksten op pagina's voorkomen te worden. Beter is om dan door te linken naar de pagina waar het onderwerp wordt behandeld.

Structuur

Bij de opzet is als uitgangspunt het volgende zoekmethode gebruikt:

Zoekstructuur

Verwijzing naar lokale pagina's
Verwijzing naar lokale pagina's op inhoudelijke pagina's wordt alsvolgt gedaan:

  ==Uitvoering per Gemeente==
Kijk hier voor de lokale organisaties die in jouw gemeente op dit vlak actief zijn:
* Katwijk
* Noordwijk
* Vijfheerenlanden
* Zoetermeer

Opmaak

Begin voor de inhoudelijke bespreking meteen korte inleidende tekst (nog voor de eerste paragaaftitel) over de inhoud van de pagina. In een toekomstige versie kan deze tekst gebruikt worden bij de zoekresultaten.

Veel gebruikte termen

Veel gebruikte begrippen en term die de voorkeur heeft:Om eenheid te krijgen in de algemene artikelen hieronder voor de meest voorkomende begrippen de term die wordt gebruikt:

Begrip Gebruikte term Eerder gebruikt en bij aanpassing van een tekst vervangen Motivatie
Hulpvrager


Client

Klant Client De term klant is zonder inhoudelijke waarde en geeft de verhouding aan die begeleider en degene die begeleiding vraagt met elkaar zullen hebben.
Hulpverlener


Maatje

Begeleider Ondersteuner


Adviseur

De term begeleider geeft inhoudelijk aan wat de rol is van degene die degene die ondersteuning vraagt.

Bestanden

Gebruik alleen bestanden als er geen mogelijkheid is om de inhoud ervan op een pagina op te nemen. De inhoud van een bestand wordt ook niet geïndexeerd m.a.w. zal de inhoud bij het zoeken ook niet worden gevonden. Bij het gebruik van bestanden letten op spaties en bijzonderdere tekens. Beter is het alleen gebruik te maken van het Alfabet en cijfers. Voor de leesbaarheid kan gebruik worden gemaakt van Camelcase (DitIsEenCamelcaseTekst)



Te bespreken...

  • Wanneer wel en wanneer niet doorverwijzen naar een externe link en waar...

In de opzet van de kennisbank hanteer ik als uitgangspunt dat het gidsen van gebruikers uitgangspunt is. Dat wil zeggen... zoveel mogelijk mensen binnen de kennisbank informeren en daarna verwijzen naar specialistische kennis. Wil graag sparren met jullie of deze opzet goed is.

  • De opzet van de lokale pagina en de meer algemene pagina. Ik zie dubbelingen ontstaan waardoor het een beetje chaos wordt.
  • Opbouw van een artikel.... bijvoorbeeld doorverwijzing altijd aan het eind (wel of niet)
  • Oplossing voor dubbelingen in zoekresultaten (algemene en lokale pagina scheiden)


  • Dubbele informatie en achtergrondinformatie (beleidswijzigingen die niet zijn omgezet in maatregelen)
  • Niet alleen een doorverwijzing

Technische Tips

Op deze pagina staan een aantal Technische Tips.