labtest documentatie
Labtest: opmaak en structuur
Vormen waarin de tekst gewoon doorkomt maar de BETEKENIS kan veranderen. Dit is de onprettigste groep: een fout levert hier geen gat op maar een gewoon ogend antwoord dat niet klopt.
Dit is een testpagina van de labtest-set. Hij staat op de echte site zodat hij door dezelfde ingest loopt als gewone documentatie. Sluit hem uit bij tellingen over de kennisbank — alles onder /documentatie/labtest/ is fixture.
Doorgehaalde tekst
De instelling AUTO_FACTUUR_OUD is vervallen; gebruik voortaan FACTUUR_AUTOMATISCH.
Verwacht: de doorhaling blijft herkenbaar. Verdwijnt die, dan leest een ingetrokken instelling als een bestaande — geen verlies maar een omkering.
Afkorting met uitschrijving
Elke WPL hangt onder een projectonderdeel.
Verwacht: iemand zoekt op "Work Package Line". Staat alleen de afkorting in de kennisbank, dan vindt hij niets.
Definitielijst
- Standaardproject
- Een sjabloon met de volledige projectstructuur waaruit per project onderdelen worden gekozen.
- Projectonderdeel
- Een deel van een project waarop uren geschreven en gefactureerd kunnen worden.
Verwacht: term en definitie blijven bij elkaar. Raken ze los, dan levert een zoekvraag op de term een definitie van iets anders op.
Ingeklapt blok
Wanneer gebruik ik een standaardproject?
Zodra dezelfde projectstructuur vaker terugkomt. Vanaf ongeveer drie vergelijkbare projecten verdient het opzetten zich terug.
Verwacht: zowel de vraag als het antwoord komen door. Bij een FAQ is de samenvatting letterlijk de vraag en dus de beste kop voor het fragment.
Waarschuwing en tip
Let op: het verwijderen van een projectonderdeel verwijdert ook de geschreven uren.
Tip: archiveer het onderdeel in plaats van het te verwijderen.
Verwacht: dat het om een waarschuwing gaat zit in de klassenaam. Zonder dat onderscheid leest "Let op" als gewone uitleg.
Voetnoot
Het uurtarief wordt jaarlijks geïndexeerd1.
- Volgens de CBS-index van oktober, tenzij in de raamovereenkomst anders is afgesproken.
Verwacht: de noot is terug te vinden bij zijn verwijzing. Belanden ze in verschillende fragmenten, dan is de voorwaarde losgeraakt van de bewering.
Statuskleur in een tabel
| Project | Status |
|---|---|
| P-114 | Binnen budget |
| P-118 | Overschreden |
Verwacht: hier staat de betekenis in de tekst én in de kleur. Een cel waar alleen de kleur het zegt, is na conversie leeg.
Genest lijstje
- Urenregistratie
- Weekstaat
- Dagstaat
- Facturering
- Factuurvoorstel
- Creditnota
Verwacht: "Weekstaat" hoort onder "Urenregistratie" en niet op hetzelfde niveau.
Code, gewoon en gekleurd
SELECT CODE, NAAM FROM PROJECTEN WHERE STATUS = 'L';UPDATE PROJECTEN SET STATUS = 'G' WHERE PJT_ID = 114;Verwacht: allebei komen ze als codeblok terug, en het gekleurde voorbeeld is niet in stukken geknipt.
Formule
De marge wordt berekend als .
Verwacht: een breuk platslaan tot losse woorden maakt de formule onleesbaar en mogelijk misleidend.
Knop zonder tekst
Klik op om de wijziging te bewaren.
Verwacht: "Opslaan" staat alleen in aria-label en title. Het icoon is een afbeelding met een LEGE alt-tekst, dus de knop draagt geen enkele tekst — zonder die attributen leest de zin als "Klik op om de wijziging te bewaren". De eerste versie gebruikte hier een icoonfont dat de site niet laadt; die knop was 15 bij 5 pixels en dus ook voor een mens onzichtbaar.