Redacció de Documentació de Gnucash
Si esteu interessats en la millora de la documentació de GnuCash, heu vingut al lloc correcte. Aquesta pàgina us proporcionarà la informació necessària per començar.
Igual que l'aplicació GnuCash s'ha desenvolupat gradualment per voluntaris, la documentació també ha estat escrita per desenvolupadors i usuaris voluntaris per ajudar a altres a aprendre com funciona GnuCash. Aquest esforç col·laboratiu s'ha traduït en la creació de dos documents principals, el Manual d'ajuda i el Tutorial i Guia de Conceptes.
La comunitat de GnuCash dóna la benvinguda a l'assistència per mantenir i millorar tant el programa com la seva documentació. Si esteu interessats en ajudar a escriure, editar o traduir la documentació de GnuCash, aquesta pàgina dóna orientació sobre com organitzar-vos per unir-vos a l'esforç.
La documentació de GnuCash pot visualitzar-se i descarregar-se a la Pàgina de la documentació.
Introducció
La documentació de Gnucash està emmagatzemada en fitxers xml. Més precisament, utilitza el sistema de docbook. Aquest és un sistema relativament flexible que pren els fitxers xml com a entrada i pot generar documentació a diversos formats de sortida diferents (html, pdf …).
Si voleu revisar o escriure documentació de GnuCash, haureu de saber xml. Alguns coneixements bàsics del sistema docbook també poden ser útils.
Els enllaços següents són per a més llocs que us poden ajudar amb la documentació i amb el procés de revisió.
- DocBook: The Definitive Guide
- DocBook XSL: The Complete Guide
- GNOME Human Interface Guidelines
- Translating_the_GnuCash_Guide_and_Help: Encara que aquesta pàgina wiki de GnuCash és realment sobre de com traduir la documentació, té informació útil de com treballar amb arxius de docbook.
- Documentation_Update_Instructions: Una guia detallada sobre com treballar amb documentació (actualització i manteniment).
Suggerim també subscriure's a gnucash-devel.
Directrius de documentació del GNOME
Com hem dit abans, la nova documentació es basa en el sistema de docbook. Tothom que vulgui ajudar si us plau seguiu aquestes guies quan sigui possible quan reviseu i/o escriviu documents.
On obtenir el codi font
You will need a recent copy of the documentation source. For this you can check out the documentation module from the gnucash-docs git repository. Reviewers could also start from the current docs tarball.
For those not familiar with git, the GnuCash wiki has a description tailored to the GnuCash code. To get the documentation source instead of the program source, replace 'gnucash' with 'gnucash-docs' in the mentioned git commands, like this:
git clone https://github.com/Gnucash/gnucash-docs.git
Els paquets principals de documentació de GnuCash per ajudar els usuaris són: el Manual d'ajuda i el Tutorial i guia de conceptes. Amb la següent comanda, es baixarà el codi font d'ambdós.
Escriptors
Aconseguiu una còpia de la font de la documentació tal com es descriu anteriorment i comenceu a fer canvis. Quan esteu satisfets amb els canvis podeu crear un pedaç executant la comanda següent al directori base de la documentació (normalment gnucash-docs, llevat que l'hagueu canviat de nom):
git diff > my-patch-name.patch
Next attach your patch to a bug report against the proper component for the Documentation product in GnuCash' bug database. See also GnuCash' wiki page on bugzilla for more details about patch submission.
Nota: solia estar bé també enviar el vostre pedaç directament a la llista de gnucash-devel. Això està desaconsellat ara, ja que un pedaç s'oblida fàcilment entre les moltes discussions de la llista. En canvi, podeu adjuntar pedassos a errors de Bugzilla (un error existent o un de nou). Si vosaltres insistiu en enviar un pedaç a gnucash-devel, hauria de ser en adjunt, no adjunt en línia.
Si us plau notifiqueu als altres escriptors quina secció voleu modificar. Deixeu constància a gnucash-devel de tal manera que els altres puguin dir 'eh! jo ja estic fent això" o "endavant, fes-ho".
També pot ser que volgueu conservar una còpia local de la documentació antiga com a referència quan redacteu. Això encara té molta informació útil que encara no ha estat transferida a la nova documentació.
Revisors
Obtenir una còpia de la font de documentació com descrit anteriorment i començar a comentar-la.
The best way of retaining comments about docs in an easy to find way for everyone would be to use bugs.gnucash.org to file the bugs under documentation. This can also be done using bug-buddy.
