WeboracleTrinnvis veiledning for brukerveiledning i xhtml med overskrifter og liste.
Du trenger
Testmiljø, nettleser og grunnleggende kjennskap til XHTML.
Slik bruker du: XHTML user manual-side viser hvordan du kan bruke et XHTML-script fra WEBoracle på en ryddig måte. Veiledningen forklarer både testing, nedlasting og hva de medfølgende dokumentene brukes til.
Før du starter
Lag en egen testmappe og pakk ut ZIP-filen der. Kontroller at du ser fire filer: scriptfilen, credits.txt, forklaring.txt og user_manual.txt. Mangler en av disse, bør pakken ikke regnes som ferdig dokumentert.
Steg 1: Les forklaringen
Start med forklaring.txt. Den skal si hva scriptet gjør, hva det ikke gjør, og hvilken situasjon det passer for. Dette gjør det lettere å vurdere om scriptet er riktig ressurs før du bruker tid på tilpasning.
Steg 2: Test scriptfilen
Kjør scriptet med en trygg testverdi. Deretter tester du tom input og en bevisst feil. Målet er å se hvordan scriptet oppfører seg når alt ikke går perfekt. Et godt script skal være forståelig også når det stopper.
Steg 3: Bruk manualen
Åpne user_manual.txt og følg punktene for installasjon, test og tilpasning. Manualen skal være kort, men konkret nok til at scriptet kan brukes uten å lese hele artikkelen på nytt.
Steg 4: Publiser eller arkiver
Når scriptet er testet, kan du legge det inn i eget prosjekt eller beholde ZIP-filen som dokumentert ressurs. Husk å endre filstier og tekst slik at de passer miljøet ditt.
Kontroller resultatet etterpå
Åpne siden der scriptet vises, test kopieringsknappen og last ned ZIP-filen på nytt. Pakk ut filen i en tom mappe og kontroller at innholdet fortsatt gir mening. Denne testen fanger ofte opp feil som ikke synes i administrasjonspanelet.
Skriv også ned hva du endret. En kort endringsnotis gjør det lettere å forstå forskjellen mellom tidligere og ny versjon, og den gir leseren bedre grunnlag for å velge riktig ressurs.
Vanlige feil
De vanligste feilene er manglende tekstfil, feil filsti, uklar versjon og kode som bare virker i redaktørens lokale mappe. Når du bruker denne veiledningen, skal slike feil oppdages før publisering.
En annen vanlig feil er at manualen blir for generell. Manualen bør nevne hvordan akkurat dette scriptet testes, ikke bare si at brukeren må teste selv.
Avslutt med en enkel kontroll: åpne scriptfilen, les forklaringen høyt for deg selv og sjekk at manualen svarer på hvordan ressursen tas i bruk. Når de tre delene henger sammen, er pakken langt mer nyttig for nye lesere.