Escriure un manual d'aplicació

Notes

Els manuals s'inclouen com a sub-pàgines de la pàgina principal de l'aplicació. Per raons de brevetat, em referiré a la pàgina principal com Appname. L'estructura, per tant, seria com:

• Appname
  • Appname/Hints and Tips
• Appname/Manual # Your Contents page
  • Appname/Manual/An Introduction to Appname
  • Appname/Manual/Configuration Choices
  • Appname/Manual/The First Time you use Appname
  • Appname/Manual/section 1
  • Appname/Manual/section xxx
  • Appname/Manual/Hints and Tips
  • Appname/Manual/Troubleshooting
  • Appname/Manual/Bug reports
  • Appname/Manual/Get involved #link to techbase etc

Recordeu!

Si us plau, no utilitzeu cap tipus de puntuació en els noms de la pàgina: La puntuació com signes d'interrogació o punts creen seriosos problemes al programari wiki, en particular al sistema de traducció.

Necessiteu un bloc de notes per experimentar amb seccions de capçaleres/pàgines. Podeu utilitzar la vostra pàgina UserTalk, o les pàgines de debat adjuntes a l'àrea on esteu treballant. És útil si es treu res que ja no és necessari, una vegada es completa el treball.

Contingut

• Un vegada preses les decisions (el que pot ser un procediment llarg), creeu els enllaços corresponents a la pàgina Contingut. Per descomptat, és possible inserir una secció més endavant, si trobeu que falta alguna cosa.

La construcció del vostre manual

• Utilitzeu els enllaços de color vermell per a crear la pàgina, i escriviu una secció cada vegada.

• Tingueu present la pàgina de debat per a qualsevol cosa a la que haureu de referir-vos més tard, com ara enllaços que encara no es poden crear.

Recordeu!

És important ser constant, sobretot en els manuals, així que aquí teniu algunes regles generals:

• Aneu amb compte amb els nivells de les capçaleres: Hem de començar en el segon nivell (Mediawiki utilitza el nivell superior pel nom de la pàgina), amb ==.

• Make sure you refer frequently to this page, to Tasks and Tools and to Typographical Guidelines

• Check if all table cells have space after the pipe character. This rule conforms with traditional wiki formatting.

• Make application name formatting consistent (avoid using Amaroks, do use Amarok's).

• Ensure that all images are in PNG format (you can use JPEG (.jpeg, not .jpg) as well, but in this case you should convert your images to PNG later). Save work by converting them before you start .

• Remove all non-printable characters from image names.

Preparar el manual per a la traducció

• The steps for markup editing can be found on Preparing a Page for Translation. Please adhere to that guide, since old markup styles may not still be relevant.