Llibre d’estil

Llibre d’estil

Format general (visual)

  • Títol de la pàgina: mida 21, en negreta i color negre. Ha de destacar clarament com a capçalera principal.
  • Text del cos: mida 14, font Arial, color negre. Sempre uniforme a totes les pàgines per facilitar la lectura.
  • Descripció de la imatge: situada just sota de cada captura, amb una frase curta que expliqui què es veu (ex: “Ping correcte des de client a router”).
  • Captures: una per cada comprovació important (configuració d’IP, ping, Vagrantfile, etc.). Han de ser clares, llegibles i sense retalls innecessaris.
  • Separació visual: deixar espais buits entre el text, la captura i la descripció. Evitar que el contingut quedi amuntegat o tallat.

Redacció del contingut

  • Estil: senzill i entenedor, com si ho expliques a algú que també fa el projecte.
  • Paràgrafs curts: màxim 4-5 línies.

⌨️ Tractament dels codis i comandes

  • Font per a codi: estil monospace (tipus code), com Consolas o Courier New.
  • Color de codi: verd, per identificar ràpidament fragments tècnics.
  • Format: sempre en línia separada, amb fons clar i llegible.