Forum Programmation.autre rédaction documentation technique avec LYX

Posté par (page perso) . Licence CC by-sa
0
18
mar.
2015

Bonjour,

Je développe essentiellement en PHP/HTML/Javascript/SQL, je me suis lancé dans l'écriture de documentation technique de mes développements au moyen de LyX.

J'aime beaucoup ce genre d'outil qui permet de se concentrer sur le contenu (sans s'occuper de la mise en forme, ni avoir à apprendre un nouveau langage ;-) et après quelques recherches sur le nain ternet, j'aimerai recueillir vos conseils éclairés :

  • confirmez-vous que ce choix est un des plus adaptés pour cette tache ?

  • actuellement j'utilise la classe de (...)

Aidez à mettre à jour le manuel de Pitivi et gagnez la biographie dédicacée de Richard Stallman !

19
8
jan.
2014
Doc

Pitivi est un logiciel libre de montage vidéo pour systèmes GNU/Linux, dont la (jolie) profession de foi est :

We believe in allowing everyone on the planet to express themselves through filmmaking, with tools that they can own and improve.

Il repose sur GStreamer pour le traitement audio/vidéo (ce qui lui permet de prétendre à l’exhaustivité en termes de formats pris en charge) et offre une interface légère (écrite en Python et utilisant la boite à outils GTK+) à la fois simple et puissante grâce à une vraie réflexion sur l'ergonomie.

Premiers pas avec Ubuntu 13.10 : le manuel Ubuntu débarque en français !

Posté par . Édité par NeoX, Benoît Sibaud, Xavier Teyssier et Nils Ratusznik. Modéré par Nils Ratusznik. Licence CC by-sa
17
6
jan.
2014
Ubuntu

Les traductions sont au cœur de la philosophie Ubuntu :

  • chacun doit avoir la liberté de télécharger, exécuter, copier, distribuer, étudier, partager, modifier et améliorer le logiciel ;
  • chacun doit avoir l’opportunité d’utiliser le logiciel, même en cas de handicap ;
  • chacun doit avoir le droit d’utiliser le logiciel dans la langue de son choix.

Nous sommes heureux et fiers de vous annoncer la sortie de la version française du célèbre Manuel Ubuntu pour Ubuntu 13.10. Le manuel vous fournit de manière claire et structurée tout ce dont vous avez besoin pour débuter puis progresser avec Ubuntu. Le Manuel Ubuntu est aussi la garantie d’instructions pas à pas qui fonctionnent, testées et intégralement en français, sans barbarismes ni mots incompréhensibles.

DocFetcher, pour rechercher des mots clés dans les fichiers

Posté par guy_R . Édité par Nÿco, Benoît Sibaud, Maxime, Benoît et Nils Ratusznik. Modéré par Benoît Sibaud. Licence CC by-sa
Tags :
15
31
déc.
2013
Communauté

Comment trouver une recette de cuisine à partir des ingrédients ? Ou un document parmi des milliers lorsque l'on ne connait que quelques mots inclus dans celui-ci ?

Ce logiciel, DocFetcher fonctionne avec Java et donc sous Linux, Mac et Windows. Il est publié sous Eclipse Public License. Il est traduit en français, russe, portugais, allemand et chinois (simplifié).

Il prend en charge les documents aux formats :

  • Microsoft Office (doc, xls, ppt) ;
  • Microsoft Office 2007 and newer (docx, xlsx, pptx, docm, xlsm, pptm) ;
  • Microsoft Outlook (pst) ;
  • Open Document (odt, ods, odg, odp, ott, ots, otg, otp) ;
  • Portable Document Format (pdf) ;
  • HTML (html, xhtml, …) ;
  • TXT et autres formats textes (personnalisable) ;
  • Rich Text Format (rtf) ;
  • AbiWord (abw, abw.gz, zabw) ;
  • Microsoft Compiled HTML Help (chm) ;
  • MP3 Metadata (mp3) ;
  • FLAC Metadata (flac) ;
  • JPEG Exif Metadata (jpg, jpeg) ;
  • Microsoft Visio (vsd) ;
  • Scalable Vector Graphics (svg).

Booktype 1.6.1 : le livre dans tous ses états

Posté par . Édité par Nÿco, Nils Ratusznik et tuiu pol. Modéré par Benoît Sibaud. Licence CC by-sa
27
8
juil.
2013
Presse

Titre de l'image

Booktype est un système de publication destiné à la création de livres (documentations, romans, essais, etc.), que ce soit au format numérique (PDF, epub, iBook…) ou pour l'impression professionnelle (Le Print).

Premiers pas avec Ubuntu 12.04 et 12.10 : les manuels Ubuntu débarquent en français

Posté par . Édité par Xavier Claude et Christophe Guilloux. Modéré par Christophe Guilloux. Licence CC by-sa
27
28
jan.
2013
Ubuntu

Nous sommes heureux et fiers de vous annoncer la sortie de la version française du célèbre Manuel Ubuntu non officiel pour Ubuntu 12.04 LTS ET pour Ubuntu 12.10. Le manuel vous fournit de manière claire et structurée tout ce dont vous avez besoin pour débuter puis progresser avec Ubuntu. Le Manuel Ubuntu est aussi la garantie d’instructions pas à pas qui marchent, testées et intégralement en français, sans barbarismes ni mots incompréhensibles.
Premiers Pas avec Ubuntu

Journal Jacob Kaplan-Moss: Écrire une bonne documentation

Posté par . Licence CC by-sa
Tags :
25
7
nov.
2012

Faisant suite à la dépêche de CrEv qui n'était pas contre un retour sur un lien posté, j'en profite pour l'établir dans ce journal.

Source : http://jacobian.org/writing/great-documentation/

Écrire des documentations de qualité

Jacob Kaplan-Moss, fort de son expérience sur la rédaction de Django Book, ouvrage libre sur le framework Web Django fait en Python, nous livre une série d'articles sur les outils, astuces et techniques qu'il a appris au cours de ces années qu'il a dépensées dans (...)

Journal [pub] MALODOS 1.3

25
19
juin
2012

Nombreux sont ceux qui, je le sait, attendaient fébrilement l'arrivée prochaine de la version 1.3 de MALODOS. qu'il soient satisfait, c'est enfin arrivé. Pour les autres, sachez que vous attendiez tout aussi fébrilement cette annonce, mais n'en n'aviez pas conscience, c'est tout.

Tout ça pour dire que j'annonce ici fièrement l'arrivée d'une nouvelle mouture de mon logiciel de gestion de document personnel, le mal nommé (mais je m'en fous) MALODOS.
Les plus attentifs d'entre vous se souviendront avec émotion des (...)

Forum général.cherche-logiciel Génération / Gestion de documentations techniques

Posté par (page perso) .
Tags :
3
15
juin
2012

Hello !

Je suis amené dans mon travail à rédiger énormément de documentation technique.

Ce travail de documentation est parfois très répétitif, surtout au sujet de la mise en page qui doit être faite de façon homogène entre les différents documents.

Je me demandais donc s'il vous connaissiez un soft (si possible libre sous Linux), qui permettrait de rédiger les docs dans un format interne à partir duquel le soft serait capable de générer les docs sous différents formats (HTML, PDF, (...)

Journal Didacticiel DITA XML : gérer ses projets multilingues

Posté par (page perso) . Licence CC by-sa
6
7
mar.
2012

DITA XML est un formidable format pour gérer les projets de documentation. Pour les projets multilingues, cependant, il faut créer un fichier .ditamap, qui contient la structure de table des matières des documents, par version. Ceci entraîne un risque d’erreurs et d’incohérences. Heureusement, une méthodologie appropriée remédie à ce problème.

Script d’automatisation élémentaire sous GPL 3 inside ;-)

De nombreux tutoriels pour se former à Linux, Java, HTML5, Flex...

Posté par Mistra formations et tutoriels . Édité par Nÿco et Benoît Sibaud. Modéré par baud123. Licence CC by-sa
30
14
déc.
2011
Linux

Mistra est un organisme de formation composé de consultants spécialisés dans des domaines tels que l'ingénierie logicielle ou l'administration système. C'est cette équipe de consultants qui, petit à petit, rédige de nombreux tutoriels sous licence CC BY-SA 3.0.

La publication de ces tutoriels a pour but d'initier les lecteurs à de nouvelles technologies ou bien de discuter de certains points plus spécifiques. Suivez ces tutoriels et donnez votre avis.

NdM : on peut aussi citer Wikibooks catégorie informatique et Wikiversity catégorie informatique comme cours et tutoriels sous une licence libre.

Journal Python en Action, PDF Libre

Posté par (page perso) . Licence CC by-sa
34
19
sept.
2011

dlfpiennes, dlfpiens, trolls.

Je viens vers vous, en écrivant ce journal, pour présenter mon PDF Libre.
Pour les plus pressé d'entre vous :

Je tiens un blog depuis quelques temps maintenant, où se côtoie deux de mes passions, programmation et monde Libre. J'ai eu l'occasion de m'intéresser plus récemment au langage Python, en y écrivant une vingtaine de billets. J'ai voulu prendre le temps de les rassembler sous un format PDF, d'un (...)

Nouvelle version pour Doxygen

Posté par (page perso) . Modéré par patrick_g. Licence CC by-sa
36
6
sept.
2011
Doc

Doxygen est un générateur de documentation à partir du code source de différents langages. Il est disponible pour les langages suivants : C, C++, C#, Fortran, Java, Objective-C, PHP, Python, IDL, VHDL, TCL et D. Les formats de sorties sont : HTML, LaTeX, RTF, PostScript, PDF (avec les hyperliens), HTML compressé et les pages de manuel Unix.

La liste des utilisateurs est grande, on retrouve KDE, Drupal, DotClear, LLVM, OpenTTD…

Doxygen est compatible avec les conventions de JavaDoc et celles de Qt. Il permet aussi de générer des graphes d’utilisation et d’héritage. Il s’utilise de la manière suivante (exemple en C++) :

/*! Classe d'exemple 
 * @author Xavier Claude
*/
public class Exemple {
    
    protected:
        /*! la description d'un attribut */
        std::string s;
    public:
        /*! La description d'une classe
         * @param newS la nouvelle valeur de s
         * @return true en cas de succès
         */
         bool setS(std::string newS);
}

Comme cela fait longtemps que les nouvelles versions de Doxygen n’ont pas été évoquées sur LinuxFr.org, un résumé des nouveautés des dernières versions est disponible en deuxième partie. Il y a bien sûr eu, en plus, beaucoup de corrections de bogues et quelques changements de comportement.