Guía para a tradución de documentación

Introdución

Para traducir un documento deberías avisar (e seguramente subscribirte, pero isto é opcional) primeiro na nosa lista de correo, por se alguén xa o está a facer. Escribe tamén á lista para pedir máis información ou calquera outra cousa que se che ocorra. Cando remates tenta enviarllo á persoa coordinadora por correo privado ou o método acordado, non o envíes nunca directamente á lista de correo. O teu documento publicarase de contado no noso proxecto, e poucos días despois estará dispoñible automaticamente no Proxecto de Documentación de Linux (Linux Documentation Project, LDP), os seus espellos e poida que tamén nalgunhas distribucións.

As recomendacións sobre estilos e formatos nos documentos é moi variable. Por exemplo non ten nada que ver unha páxina do manual cunha de info, e ningunha destas dúas ten tampouco nada que ver con HOWTO e guías, que adoitan estar en HTML, texto plano, PostScript, … Ademais disto, os documentos de tipo guías, HOWTO e FAQ non están sempre nos mesmos formatos, e incluso a aparencia no caso de que estea nos mesmos formatos non é sempre idéntica.

Por este motivo, e tamén porque o traballo no campo da documentación non é moi activo ultimamente, non temos ningún estándar oficial ou oficioso. Así que seguramente o mellor é que collas varios documentos do tipo do que o queres facer/traducir ti, compares e decidas. No HOWTO Index hai varias recomendacións neste aspecto que, se ben están pensadas para escribir novos HOWTO, tamén son válidas en parte para traducións.

Porén, temos por costume engadir un apéndice con información sobre este proxecto. O modelo pódelo baixar con esta ligazón, está en formato HTML.

Lembra adaptar as ligazóns, o título e demais para o teu documento, así como modificar o resto da estrutura (índice, ligazóns desde o último capítulo/apéndice do orixinal, etc) no caso de que estea en HTML. Loxicamente, no caso doutros formatos terás que modificalo para seguir o formato que uses.

Finalmente, lembra que moitos documentos teñen licenzas restritivas e tes que obter por exemplo o permiso do autor para poder traducilo, ou que se manteña o nome e enderezo electrónico do autor e sitio onde conseguir o orixinal. Non publicaremos, por suposto, documentos que non cumpran os requisitos.

Variantes

GUÍAS

Aínda que temos máis guías que as do LDP, só explicamos estas porque as outras poden ter contidos moi variables. As guías do LDP son documentos normalmente bastante extensos (por riba das 100 páxinas, imprimido cun tamaño de letra normal en folios DINA4), que tratan tamén sobre temas moi amplos.

Exemplos poden ser a Guía de Instalación e Comezo con Linux, a Guía do Administrador de Redes, a Guía do Programador, …

Adoitan estar en case todos os formatos que están explicados máis abaixo.

HOWTO

Os documentos tipo HOWTO do Proxecto de Documentación de Linux son documentos de lonxitude moi variable pero que normalmente tratan só dun aspecto moi específico, como pode ser o Sistema X Window, como ter son no teu computador ou a integración pacífica de varios sistemas operativos na mesma máquina.

Hai dentro deste mesmo tipo os subtipos HOWTO e mini-HOWTO, que non teñen grandes diferenzas nin hai unha maneira clara de clasificalos; pero como poderás intuír, os mini-HOWTO adoitan seren máis curtos e/ou tratan de temas máis específicos.

Adoitan estaren en case todos os formatos que están explicados máis abaixo.

Formatos dos documentos

HTML
HyperText Markup Language, o formato no que atopas as páxinas web. Úsase normalmente para ler (en liña ou non). Adoita estar repartido en varios ficheiros, aínda que ás veces aparece todo o documento no mesmo ficheiro.
HTML.tar.gz
Este non é nada máis que o anterior pero empaquetando todos os ficheiros individuais nun arquivo tar e comprimido co gzip.
SGML
Standard Generalized Markup Language. Este é o formato base no que están escritos a maioría dos documentos do LDP (agás as páxinas man), porque coas ferramentas axeitadas convértese o documento ao resto dos formatos.
TXT
Simple texto plano. Neste formato o documento adoita estar nun só ficheiro, ás veces comprimido co gzip.
DVI
DeVice Independent, un só ficheiro preparado para imprimir.
PS

PostScript, un só ficheiro listo para imprimir directamente nalgunhas impresoras que soportan o estándar do desmo nome.

PDF
Portable Document Format, un formato como outro calquera, tamén usado case sempre para imprimir directamente o documento desde un único ficheiro.

Data de actualización: Xuño-2005

Deixe unha resposta

O teu enderezo electrónico non se publicará Os campos obrigatorios están marcados con *

*

Este sitio emprega Akismet para reducir o spam. Aprende como se procesan os datos dos teus comentarios.