Accions

Guia d'estil del wiki: diferència entre les revisions

De Recursos docents

Cap resum de modificació
(Hi ha 15 revisions intermèdies del mateix usuari que no es mostren)
Línia 1: Línia 1:
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.
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==
==Estructura general==


* El títol ha de ser breu, descriptiu i rellevant. Cal evitar títols massa genèrics
* 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.
* 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à:
* 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à:
Línia 12: Línia 12:
==Normes d'estil==
==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).
* '''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.
* 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.
* '''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.
: {| class="wikitable"
<div style="margin-left: 40px;">
:   ! Estil recomanat !! Estil per evitar
{| class="wikitable"
:   |-
   ! Estil recomanat !! Estil per evitar
:   | Recomanem seguir aquestes instrruccions. || Es recomana seguir aquestes instruccions.
   |-
:   |-
   | Recomanem seguir aquestes instruccions. || Es recomana seguir aquestes instruccions.
:   | Obre el fitxer.<br>Obrim el fitxer.<br>Cal obrir el fitxer. || S'obre el fitxer.<br>Obriu el fitxer.
   |-
:   |-
   | Obre el fitxer.<br>Obrim el fitxer.<br>Cal obrir el fitxer. || S'obre el fitxer.<br>Obriu el fitxer.
:   | Recomanem l'ordre alfabètic. || Es prefereix l'ordre alfabètic.
   |-
:   |}
   | 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.
   |}
: {| class="wikitable"
</div>
:   ! Estil recomanat !! Estil per evitar
* 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.
:   |-
<div style="margin-left: 40px;">
:   | 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.
{| class="wikitable"
: |}
   ! Estil recomanat !! Estil per evitar
A continuació, apareixen els detalls d'interès. 
   |-
* Stating the obvious before and after
   | 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.
* Click
|}
* nllaços interns:
</div>


  - Afegiu enllaços a altres pàgines wiki relacionades (`[[Pàgina Relacionada]]`).
== Format del text ==
  - No repeteixis enllaços per al mateix terme dins d'una mateixa secció.
* Negreta: Per destacar termes clau (només a la primera menció): '''Text en negreta'''.
Enllaços externs:
* Cursiva: Per a títols d'obres o noms científics: ''Text en cursiva''.
  - Col·loca'ls al final de la pàgina, sota una secció com **"Enllaços externs"**.
*Llistes:
  - Utilitza `[URL Descripció]` per afegir un enllaç formatat.
**Puntuals. Utilitza * per crear llistes amb punts.
**Numerades. Utilitza # per crear llistes amb números.


==Formateig del text==
*Taules. Utilitza el codi de taula bàsic (amb contenidor div per fer sagnat si cal):
Negreta: Per destacar termes clau (només a la primera menció): `'''Text en negreta'''`.
<div style="margin-left: 40px;">
Cursiva: Per títols d'obres o noms científics: `''Text en cursiva''`.
<pre>
Llistes:
<div style="margin-left: 40px;">
  - Puntuals: Utilitza `*` per crear llistes amb punts.
  - Numerades: Utilitza `#` per crear llistes amb números.
Taules: Utilitza el codi de taula bàsic:
  ```wiki
   {| class="wikitable"
   {| class="wikitable"
   ! Capçalera 1 !! Capçalera 2
   ! Capçalera 1 !! Capçalera 2
Línia 56: Línia 53:
   | Fila 2, Columna 1 || Fila 2, Columna 2
   | Fila 2, Columna 1 || Fila 2, Columna 2
   |}
   |}
  ```
</div>
</pre>
</div>
 
== Ús d'imatges ==
Lorem ipsum


==Citacions i referències==
== Ús de vídeo ==
- Utilitza referències per donar suport a les afirmacions:
Lorem ipsum
  - 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==
==Qualitat==
Idioma: Si estàs redactant en català, assegura't de seguir les normes ortogràfiques i gramaticals de l'IEC.
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!
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ó.

Revisió del 12:16, 28 gen 2025

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!