Guia d'estil del wiki
De Recursos docents
Aquesta guia d'estil sobre la redacció de pàgines d'aquest wiki s'inspira en les bones pràctiques habituals en entorns MediaWiki (utilitzat per Wikipedia) i altres sistemes semblants.
Estructura general
- El títol ha de ser breu, descriptiu i rellevant. Cal evitar títols massa genèrics
- Introducció. Proporciona un resum breu del tema (màxim 2-3 frases). Defineix el concepte o tema principal.
- Cos del text. Divideix la informació en seccions i subseccions clares, utilitzant els encapçalaments amb codi wiki adequats. L'estructura bàsica mínima de les pàgines instructives sobre eines i recursos serà:
- Què és
- Com es fa servir
- Per saber-ne més
Normes d'estil
- Claredat. Utilitza frases curtes i senzilles. Evita paraules tècniques i abreviatures, tret que siguin necessàries (i explica-les si cal).
- Cal mantenir un estil proper i directe, sense recórrer a un to col·loquial.
- Persones. La persona que escriu pot identificar-se en primera persona plural (nosaltres). La persona que llegeix s'identifica en segona persona singular (tu, no pas vosaltres). Recomanem escriure instruccions per a tu o per a nosaltres, o sigui, l'autor@ i la lector@ junt@s. I també podem escriure instruccions impersonals (Cal..., És preferible, etc.) però en general cal evitar les formes pronominals impersonals (Una vez que se haya..., etc.). A continuació, donem uns exemples d'estil personal recomanat.
- ! Estil recomanat !! Estil per evitar
- |-
- | Recomanem seguir aquestes instrruccions. || Es recomana seguir aquestes instruccions.
- |-
- | Obre el fitxer.
Obrim el fitxer.
Cal obrir el fitxer. || S'obre el fitxer.
Obriu el fitxer. - |-
- | Recomanem l'ordre alfabètic. || Es prefereix l'ordre alfabètic.
- |}
- Simplicitat. Cal mantenir el temps verbal present durant una seqüència d'instruccions. Val evitar fer referència a la mecànica d'hipertext.
- ! Estil recomanat !! Estil per evitar
- |-
- | A continuació, podem veure els detalls d'interès. || Despés de fer clic en l'enllaç "Següent", s'obrirà una pàgina amb els detalls d'interès.
- |}
- Stating the obvious before and after
- Click
- nllaços interns:
Capçalera 1 Capçalera 2 Fila 1, Columna 1 Fila 1, Columna 2 Fila 2, Columna 1 Fila 2, Columna 2 ```
Citacions i referències
- Utilitza referències per donar suport a les afirmacions:
- Sintaxi: `<ref>Font de la informació</ref>`. - Afegeix una secció **"Referències"** amb el codi: ```wiki == Referències == <references /> ```
Seccions habituals
Introducció: Resum del tema. Context: Antecedents. Característiques: Detalls del tema. Impacte o Aplicacions: Rellevància. Referències: Fonts citades. Enllaços Externs: Recursos addicionals.
Consistència
Idioma: Si estàs redactant en català, assegura't de seguir les normes ortogràfiques i gramaticals de l'IEC. Estil: Mantén el mateix to i format al llarg de tot el text. Revisions: Torna a llegir el text per eliminar errors i millorar-ne la comprensió.