Ara mateix estem diferenciant entre tres tipus de documents en
les aportacions. Intentarem explicar el significat de cascun d'ells i
en línies
generals quins criteris han de cobrir.
- PMF:
style="font-style: italic;">Pregunta
style="font-style: italic;">Més
style="font-style: italic;">Freqüent.
- CEF: Guia de "
style="font-style: italic;">Com
style="font-style: italic;">Es
style="font-style: italic;">Fa" alguna cosa.
- Article.
A continuació, s'explica el format i el contingut que hauria de
tenir cadascun d'aquests documents, d'aquesta manera podrem catalogar
cada aportació en algun d'ells.
Procurant respectar els criteris generals que es descriuen en
[Redacció de documents], unificar criteris i proporcionar un
patró a l'hora de redactar-les:
- PMF:
Les PMFs donen resposta a preguntes sobre conceptes i necessitats que
es poden tenir. Així, donen resposta des d'una
definició a un concepte o paraula, fins a encaminar a
programari relacionat amb la pregunta o altra informació
pertinent.
A partir d'aquesta informació base, hom pot continuar la
seva cerca cap als CEFn, Internet, bibliografia, xats, llistes de
correu, etc.
Format:
Les PMF, estaran formades per una pregunta (que la posarem com a
Títol) i la resposta adequada (en el cos de la
aportació). El format de la pregunta i la resposta
seguiran la forma següent:
- Pregunta: Serà breu, clara i molt centrada en el
tema. Intentant evitar que pugui confondre o fer referència a
altres conceptes.
- Resposta: A de dirigir-se a la pregunta. S'hauria d'evitar
repetir respostes amb diferents paraules (Només s'ha
de possar una resposta clara a una pregunta, les que poden portar
a confusió seran omeses).
- CEF:
Donen solució a un aspecte específic. Així,
a partir d'un problema/necessitat, s'ofereixen una mena de guia de com
resoldre-ho, típicament amb el programari específic sobre
el problema que es dirigeix.
Format:
Les CEF, estaran formades per un breu enunciat (que posarem com a
Títol) i el text que contingui la informació
necessària perque en sí mateix dongui una
orientació clara a la qüestió a la que es dirigeix.
Com que els continguts poden quedar fàcilment desactualitzats,
és bo que el text en si mateix ja tingui prou significat
perquè sigui prou entenedor per a la questió que l'ha
motivat. En aquest sentit pot ser bó fer referències a on
aconseguir més informació etc. Els enllaços de
vegades són un bon recurs, pero tampoc convé
abusar-ne, també es poden quedar desactualitzats, i si
resulta que els enllaços no funcionen i fora el que li dona el
significat... adéu CMF.
- Article:
Els articles seran documents on es faci una anàlisi d'algun tema.
Els articles no necessariament han de ser documents de formació
a novells com són les PMFs o els CEFn. La finalitat
principal dels articles es la de ser documents
"d'innovació'', de reflexió o de revisió
sobre qualsevol tema relacionat amb la informàtica,
més o menys relacionat amb el que es descriu al manifest del
projecte.