Category Archives: Documentations

Illustrer vos documents/présentations/communications…

…avec des outils disponibles gratuitement sur internet :

  • éditeur de diagramme draw.io : des dizaines de types de diagrammes disponibles (business, graphes, ingénierie, flux, cartes, réseaux, logiciels, uml…) enregistrable dans le cloud ou localement

draw_io_network

  • générateur de nuage de mots NuagesDeMots.fr : les mots affichés sont sélectionnés dans un document texte fourni par vos soins, et la taille des mots est déterminée par leur fréquence d’apparition dans ce document.

nuagesdemots

… avec des outils disponible sur votre poste de travail (Windows)

  • enregistreur d’action utilisateurs (PSR.EXE) : l’outil « Problem Step Recorder » (plutôt prévu pour débuger un problème côté utilisateur) réalise des photos d’écrans des fenêtres ou des boutons impactés par chaque clic ou saisie de texte. Très pratique pour réaliser une documentation pas à pas pour les non initiés. (meme si personnellement je préfère une version full text).

Guide de bonnes pratiques pour les Administrateurs Systèmes et Réseaux

Le « Guide de bonnes pratiques  pour les Administrateurs Systèmes et Réseaux » (par Olivier Brand-Foissac, Laurette Chardon, Marie David,Maurice Libes, Gilles Requilé, Alain Rivet) « vise à déterminer les pratiques et les processus à mettre en place sur le terrain, pour une meilleure organisation du travail, afin d’améliorer la qualité et la fourniture de services, la sécurisation de nos serveurs et réseaux, la documentation de nos actions, la communication avec les utilisateurs, la prise en compte des évolutions technologiques, et in fine la lisibilité de nos activités d’ASR. »

Rédaction de documentation au format texte ET html

Le format reStructuredText donne la possibilité de rédiger une documentation très lisible en mode texte, à partir de laquelle une page web statique peut être générée.

C’est en quelque sorte un wiki, mais qui ne nécessite pas de faire tourner un serveur web. Ce langage est utilisé par DocUtils (générateur de documentation) et Sphynx (générateur de documentation python)

Des exemples sur http://docutils.sourceforge.net/docs/user/rst/quickstart.html

Et pour générer une page html à partir du fichier texte :

~$ rst2html fichier_texte.txt > fichier_html.html

Le même format permet aussi de générer des présentations avec des effets plutôt simples, mais impressionnants. Voir la démo d’hovercraft.

JavE, un outil de dessin « Ascii Art »

« JavE est un editeur Ascii gratuit. Plutôt que d’éditer de simples textes, cet outil permet de dessiner des diagrammes basiques en utilisant les caractères ascii. C’est une sorte d’outil de dessin pour manipuler du texte plutôt que des images »

Il est développé en Java et fonctionne donc sur de nombreuses plateformes.

Exemple :

                       ,_________
                       |        |
            LAN 1      |        |
........       __,,.--''SERVER  |
|      |,..--'''       |        |
| NAS  '               |        |
|      |               |        |
|______J`.             '`'''|''''
          `.                |
            `.LAN 2         |
                           |
               `.           |
                 `.         |
                   `.       |
           ..........:......:.....b
           |   SWITCH             |
           |                      |
           '`''''''''''''''''''''''
               192.168.1.0/24