Revision [1932]
Last edited on 2009-04-16 09:45:20 by PaulBeAdditions:
[[FrenchPhplistDocumentation phplist Documentation]]
Deletions:
Revision [1921]
Edited on 2009-04-15 17:10:39 by PaulBeAdditions:
===== ===== Lignes directrices pour la rédaction de documentation
Pour préserver la cohérence de l'ensemble des pages de documentation, veuillez s'il vous plait respecter les lignes directrices suivantes lors de la création / édition d'une page de documentation.
~-Lors de la création d'une nouvelle page de documentation, vérifiez au préalable qu'une page similaire rédigée par quelqu'un d'un autre n'existe pas déjà sur le même sujet
~ Ajoutez également l'entête et pied de page suivants à chaque page de documentation:
[[PhplistDocumentation phplist Documentation]]
----
==== Titre de la page ====
Voici le contenu d'une page de documentation
...
...
...
...
----
CategoryDocumentation
%%
~ Vous pouvez générer directement des pages de documentation pré-formaté par "clonage" de la [[http://wikka.phplist.com/DocumentationTemplate/clone DocumentationTemplate]]
~-Veuillez ne pas créer de documentation pour des fonctions qui ne sont pas encore incluses dans le [[http://tincan.co.uk/releasenotes officielle phplist release notes]]
Pour préserver la cohérence de l'ensemble des pages de documentation, veuillez s'il vous plait respecter les lignes directrices suivantes lors de la création / édition d'une page de documentation.
~-Lors de la création d'une nouvelle page de documentation, vérifiez au préalable qu'une page similaire rédigée par quelqu'un d'un autre n'existe pas déjà sur le même sujet
~ Ajoutez également l'entête et pied de page suivants à chaque page de documentation:
[[PhplistDocumentation phplist Documentation]]
----
==== Titre de la page ====
Voici le contenu d'une page de documentation
...
...
...
...
----
CategoryDocumentation
%%
~ Vous pouvez générer directement des pages de documentation pré-formaté par "clonage" de la [[http://wikka.phplist.com/DocumentationTemplate/clone DocumentationTemplate]]
~-Veuillez ne pas créer de documentation pour des fonctions qui ne sont pas encore incluses dans le [[http://tincan.co.uk/releasenotes officielle phplist release notes]]
Deletions:
To preserve the overall consistency of documentation pages, please respect the following guidelines when creating/editing a documentation page.
~-When creating a new documentation entry, please check that another page on the same topic does not already exist
~-Please add the following header and footer to every documentation page:
[[PhplistDocumentation phplist Documentation]]
----
====Title of the page ====
Here goes page content
...
...
...
...
----
CategoryDocumentation
%%
~You can directly generate well-formatted documentation pages by "cloning" the [[http://wikka.phplist.com/DocumentationTemplate/clone DocumentationTemplate]]
~-Do not create documentation entries for features that are not yet included in the [[http://tincan.co.uk/releasenotes official phplist release notes]]
