Guia d'estil del wiki
De Recursos docents
Aquesta guia d'estil sobre la redacció de pàgines del wiki s'inspira en les bones pràctiques habituals en entorns MediaWiki (utilitzat per Wikipedia) i altres sistemes semblants. El wiki es redacta en català per defecte. (S'estudia la possibilitat de posar-hi un botó de traducció automàtica.)
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 vegada que se hagi..., etc.). A continuació, donem uns exemples d'estil personal recomanat.
| Estil recomanat | Estil per evitar |
|---|---|
| Recomanem seguir aquestes instruccions. | 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. Cal evitar fer referència a la mecànica d'hipertext (enllaç, clic, etc.) i els detalls del pas anterior.
| Estil recomanat | Estil per evitar |
|---|---|
| A continuació, podem veure els detalls d'interès. | Després de fer clic en l'enllaç "Següent", s'obrirà una pàgina amb els detalls d'interès. |
Format del text
- Negreta: Per destacar termes clau (només a la primera menció): Text en negreta.
- Cursiva: Per a títols d'obres o noms científics: Text en cursiva.
- Llistes:
- Puntuals. Utilitza * per crear llistes amb punts.
- Numerades. Utilitza # per crear llistes amb números.
- Taules. Utilitza el codi de taula bàsic (amb contenidor div per fer sagnat si cal):
<div style="margin-left: 40px;">
{| class="wikitable"
! Capçalera 1 !! Capçalera 2
|-
| Fila 1, Columna 1 || Fila 1, Columna 2
|-
| Fila 2, Columna 1 || Fila 2, Columna 2
|}
</div>
Ús d'imatges
Lorem ipsum
Ús de vídeo
Lorem ipsum
Qualitat
A mesura que avancis en l'edició d'una pàgina wiki, convé compartir-la amb amb una company@ de l'equip d'edició. A l'hora d'eliminar errors i millorar-ne la redacció, quatre ulls veuen més que dos!