Vous avez un projet informatique mais votre documentation est incomplète, difficile à comprendre ou inexistante ?

Je peux rédiger une documentation technique claire, structurée et adaptée à votre projet, afin de faciliter son installation, sa maintenance, sa prise en main ou sa transmission à une autre personne.

Ce que comprend l’offre de base

Pour $58.07, je rédige 1 document technique court et ciblé, jusqu’à environ 3 pages, à partir des informations et éléments que vous me fournissez.

Cela peut par exemple concerner :

un README GitHub ;
une procédure d’installation ;
un guide de configuration ;
une procédure de déploiement ;
une documentation d’API simple ;
un guide utilisateur technique ;
une procédure de maintenance ou d’exploitation ;
la documentation d’un script ou d’une petite application.

Je structure le document avec des titres clairs, des étapes numérotées, des prérequis, des commandes ou exemples techniques lorsque cela est nécessaire.

Livrable

Le document peut être fourni au format Markdown, texte ou document structuré, selon votre besoin.

Ce dont j’ai besoin

Merci de me transmettre les informations techniques nécessaires : code source ou extraits pertinents, fonctionnement du projet, étapes attendues, captures éventuelles et toute documentation existante.

Important

L’offre de base concerne une documentation courte et ciblée. Une documentation complète de projet, plusieurs procédures, une API importante ou un document nécessitant une analyse approfondie feront l’objet d’une option adaptée.

Une retouche mineure est incluse après livraison afin de corriger ou préciser un élément déjà prévu dans le périmètre initial.