Difference between revisions of "FR/Wiki/Structure:Documentation"

From Apache OpenOffice Wiki
< FR‎ | Wiki
Jump to: navigation, search
(Types de documents)
 
(→‎Des pages pour des liens externes)
(3 intermediate revisions by the same user not shown)
Line 1: Line 1:
 
{{DISPLAYTITLE:Les différents types de documents}}
 
{{DISPLAYTITLE:Les différents types de documents}}
  
−
Grossièrement, on pourrait scinder la documentation existante en trois parties :
+
Grossièrement, on pourrait scinder la documentation existante en trois, et même quatre parties :
 
# Les manuels de référence ou guides, des ouvrages couvrant un domaine et pouvant atteindre plusieurs centaines de pages.
 
# Les manuels de référence ou guides, des ouvrages couvrant un domaine et pouvant atteindre plusieurs centaines de pages.
 
# Les How-tos ou mini-guides couvrant un domaine plus précis, d'un contenu généralement compris entre une et trente pages.
 
# Les How-tos ou mini-guides couvrant un domaine plus précis, d'un contenu généralement compris entre une et trente pages.
Line 33: Line 33:
 
* Pour ce qui est du guide pour le débutant, [[Documentation/OOo3_User_Guides/Getting_Started]], considérez plutôt [http://fr.openoffice.org/servlets/ReadMsg?list=doc&msgNo=9970 cette annonce d'Éric Bachard].  :-)
 
* Pour ce qui est du guide pour le débutant, [[Documentation/OOo3_User_Guides/Getting_Started]], considérez plutôt [http://fr.openoffice.org/servlets/ReadMsg?list=doc&msgNo=9970 cette annonce d'Éric Bachard].  :-)
  
−
A noter que les deux premiers cités ont été réalisés en accord avec les liens inter-wikis automatiques. L'unique différence réside dans les adresses des pages, chez nous augmentées des trois caractères "/FR" directement après l'adresse de base. Ceci permet de "synchroniser" les langues, un modèle simple assurant la liaison automatique entre chaque page.  
+
A noter que le guide d'administration et le guide de programmation Basic ont été réalisés en accord avec les liens inter-wikis automatiques. L'unique différence réside dans les adresses des pages, chez nous augmentées des trois caractères "/FR" directement après l'adresse de base. Ceci permet de "synchroniser" les langues, un modèle simple assurant la liaison automatique entre chaque page.  
  
 
Mais ceci enlèverait la recherche en français dans les moteurs de recherche. Je m'exprime au conditionnel car je n'ai pas trouvé d'exemple probant de ce défaut, partant du principe que les mots-clés de ma recherche sont ceux présents dans le titre affiché par la commande DISPLAYTITLE. Mais j'ai également observé que, si la réponse arrive bien en première ligne dans Google, elle s'effectue sur les mots dans la page, et non la commande DISPLAYTITLE. Ce dernier constat implique au rédacteur de reprendre les mots traduits dans le corps de la page, en plus de la commande DISPLAYTITLE, pour qu'une recherche en français soit efficiente.
 
Mais ceci enlèverait la recherche en français dans les moteurs de recherche. Je m'exprime au conditionnel car je n'ai pas trouvé d'exemple probant de ce défaut, partant du principe que les mots-clés de ma recherche sont ceux présents dans le titre affiché par la commande DISPLAYTITLE. Mais j'ai également observé que, si la réponse arrive bien en première ligne dans Google, elle s'effectue sur les mots dans la page, et non la commande DISPLAYTITLE. Ce dernier constat implique au rédacteur de reprendre les mots traduits dans le corps de la page, en plus de la commande DISPLAYTITLE, pour qu'une recherche en français soit efficiente.
Line 71: Line 71:
  
 
Ceci pourrait-être également un moyen de rendre visible plus de documentation francophone sur ce wiki {{OOo}}... et par le biais des sous-pages, assigner des catégories, et recréer des "tables des matières" par requêtes DPL
 
Ceci pourrait-être également un moyen de rendre visible plus de documentation francophone sur ce wiki {{OOo}}... et par le biais des sous-pages, assigner des catégories, et recréer des "tables des matières" par requêtes DPL
 +
 +
=== <center>Des pages pour des liens externes</center> ===
 +
 +
Nous devrions créer nombre de sous-pages pour référencer - progressivement - l'ensemble de la documentation francophone.
 +
* Par le fait, le cahier des charges est assez conséquent. Mais si cela représente un [[:Category:Effort|effort]], il reste évidemment bien moindre que la documentation elle même. C'est aussi lui rendre hommage - et surtout visibilité. Un document de qualité mérite bien une page, visible au moins depuis une catégorie.
 +
* À terme, les pages d'accueils des guides, How-Tos pourront être nourries par requêtes. Si la catégorie devient vraiment peuplée, il sera alors agréable de créer des sous-catégories, et ainsi constituer une table des matières qui saura rester claire...
 +
* Pour le coté visuel de cette tâche, nous pourrions créer au moins deux modèles :
 +
*# [[Template:FR/CitePage]] présentant, sous forme d'un tableau, les paramètres suivants :
 +
*## Titre >> Titre du document
 +
*## PlateForme >> Optionnel. Sinon valeur par défaut: "Toutes"
 +
*## Descriptif >> Court descriptif d'une à quelques phrases
 +
*## VersionDebut >> Depuis quelle version de {{OOo}} ?
 +
*## VersionFin >> Jusqu'à quelle version de {{OOo}} ?
 +
*## Date >> De dernière modification
 +
*## Lien >> Lien vers la page (d'accueil)
 +
*## L'aide est maintenue dans le modèle et vous pouvez consulter [[Template_talk:FR/CitePage|sa page ''Discussion'']].
 +
*# Template:FR/CiteDocument, contenant en plus du premier :
 +
*## LienDoc >> Cette fois le lien de téléchargement direct
 +
*## Type >> Type du document (ODT, PDF, etc...)
 +
*## Poids >> Poids du fichier, exprimé en Ko, Mo...
 +
 +
Pour l'instant seul le premier existe mais moyennant une petite rigueur de saisie tout peut aisément tenir dans le paramètre ''Lien''.
  
 
{{PDL1}}
 
{{PDL1}}
 
[[Category:FR/Wiki_Guide|Documentation]]
 
[[Category:FR/Wiki_Guide|Documentation]]

Revision as of 11:31, 25 May 2009


Grossièrement, on pourrait scinder la documentation existante en trois, et même quatre parties :

  1. Les manuels de référence ou guides, des ouvrages couvrant un domaine et pouvant atteindre plusieurs centaines de pages.
  2. Les How-tos ou mini-guides couvrant un domaine plus précis, d'un contenu généralement compris entre une et trente pages.
  3. La FAQ ou les questions fréquemment posées, une question précise, une réponse concise.
  4. A noter que les anglophones ont une section Tutorials, ou les documents sont regroupés par auteur.

Les guides

Il n'y en a pas énormément disponibles sur le Wiki en français. Mais en revanche il contiennent nombre de sous-liens et l'adresse de base gagne à être courte, sans redondance :

Template:Documentation/FR/Note

  • Le guide d'administration, à l'adresse FR/Documentation/Administration_Guide
  • Le guide de programmation Basic : FR/Documentation/BASIC_Guide
  • Le guide pour Writer v3 : FR/Documentation/Writer_Guide
  • Le guide HSQLDB : FR/Documentation/HSQLDB_Guide
  • Les fonctions listées par catégories pour Calc : FR/Documentation/Calc/Fonctions_listees_par_categories
  • Sur le site standard, il y a des guides très intéressant : [1]
    • Bien sur Tony, j'aurais dû même mettre ce lien en tête de liste puisqu'il représente notre première "banque de données", dans l'ordre chronologique... et contient vraiment des mines d'information. En même temps et à moins de déjà bien en avoir exploré le contenu, il faut reconnaître que pour un débutant...
    • Personnellement je me souhaite un bon courage en arrivant ici, car je me dis qu'il va falloir que je télécharge les quelques documents en rapport avec ce que je recherche, puis que je les compare entre eux - car notamment "date" et "pour quelle version" ne sont pas toujours clairement définis...
    • Je tente de répondre à ce constat, au paragraphe "Des pages pour des liens externes".
  • Ajoutez un oubli...



Tip.png Pour les courageux, entreprises de traductions à lancer :


A noter que le guide d'administration et le guide de programmation Basic ont été réalisés en accord avec les liens inter-wikis automatiques. L'unique différence réside dans les adresses des pages, chez nous augmentées des trois caractères "/FR" directement après l'adresse de base. Ceci permet de "synchroniser" les langues, un modèle simple assurant la liaison automatique entre chaque page.

Mais ceci enlèverait la recherche en français dans les moteurs de recherche. Je m'exprime au conditionnel car je n'ai pas trouvé d'exemple probant de ce défaut, partant du principe que les mots-clés de ma recherche sont ceux présents dans le titre affiché par la commande DISPLAYTITLE. Mais j'ai également observé que, si la réponse arrive bien en première ligne dans Google, elle s'effectue sur les mots dans la page, et non la commande DISPLAYTITLE. Ce dernier constat implique au rédacteur de reprendre les mots traduits dans le corps de la page, en plus de la commande DISPLAYTITLE, pour qu'une recherche en français soit efficiente.

Par exemple, quelques recherches efficaces dans le guide d'administration via Google :

Si vous trouvez une recherche inefficace malgré que les termes recherchés soient inclus dans la commande DISPLAYTITLE, merci de l'ajouter ici-même afin de discuter ce constat :

Les How-Tos

Ceux-ci sont déjà plus nombreux :

Les FAQ

Elles sont souvent impressionnantes :

  • FR/FAQ. A noter que les anglais en on fait une sous-page de Documentation, soit Documentation/FAQ. (c'est logique, il peut exister d'autres FAQ, mais c'est plus long et probablement inutile dans le cas d'une localisation).

Les Tutoriels

Nos amis anglophones ont donc une partie Tutorials...

Et nous, nous avons de la documentation "externe" sur divers sites dédiés à Apache OpenOffice :


Effectivement, créer une page FR/Documentation/Tutoriels ajouterait une section non négligeable à la documentation...

Selon la richesse de la présentation (entre une seule liste et une sous-page par lien, accompagné d'une ou deux phrases descriptives du tutoriel), ceci représenterait une somme de travail, non seulement pour la création mais aussi la maintenance de toutes ces sous-pages... Liens dont il faudrait vérifier de temps en temps la pertinence...

Ceci pourrait-être également un moyen de rendre visible plus de documentation francophone sur ce wiki Apache OpenOffice... et par le biais des sous-pages, assigner des catégories, et recréer des "tables des matières" par requêtes DPL

Des pages pour des liens externes

Nous devrions créer nombre de sous-pages pour référencer - progressivement - l'ensemble de la documentation francophone.

  • Par le fait, le cahier des charges est assez conséquent. Mais si cela représente un effort, il reste évidemment bien moindre que la documentation elle même. C'est aussi lui rendre hommage - et surtout visibilité. Un document de qualité mérite bien une page, visible au moins depuis une catégorie.
  • À terme, les pages d'accueils des guides, How-Tos pourront être nourries par requêtes. Si la catégorie devient vraiment peuplée, il sera alors agréable de créer des sous-catégories, et ainsi constituer une table des matières qui saura rester claire...
  • Pour le coté visuel de cette tâche, nous pourrions créer au moins deux modèles :
    1. Template:FR/CitePage présentant, sous forme d'un tableau, les paramètres suivants :
      1. Titre >> Titre du document
      2. PlateForme >> Optionnel. Sinon valeur par défaut: "Toutes"
      3. Descriptif >> Court descriptif d'une à quelques phrases
      4. VersionDebut >> Depuis quelle version de Apache OpenOffice ?
      5. VersionFin >> Jusqu'à quelle version de Apache OpenOffice ?
      6. Date >> De dernière modification
      7. Lien >> Lien vers la page (d'accueil)
      8. L'aide est maintenue dans le modèle et vous pouvez consulter sa page Discussion.
    2. Template:FR/CiteDocument, contenant en plus du premier :
      1. LienDoc >> Cette fois le lien de téléchargement direct
      2. Type >> Type du document (ODT, PDF, etc...)
      3. Poids >> Poids du fichier, exprimé en Ko, Mo...

Pour l'instant seul le premier existe mais moyennant une petite rigueur de saisie tout peut aisément tenir dans le paramètre Lien.

Content on this page is licensed under the Public Documentation License (PDL).
Retrieved from "https://wiki.openoffice.org/w/index.php?title=FR/Wiki/Structure:Documentation&oldid=129149"
Personal tools