Je vais écrire ou améliorer votre README github et la documentation de votre projet
README GitHub et documentation Markdown
À propos de ce service
Rendez votre projet plus facile à comprendre et à utiliser. Je vais améliorer une page README GitHub ou une documentation Markdown/MDX, jusqu’à 1 500 mots.
Votre livraison inclut une structure et une rédaction plus claires, des instructions d’installation et d’utilisation basées sur les références que vous fournissez, une mise en forme et des liens corrigés, ainsi qu’un fichier source modifié ou une pull request ciblée vers un dépôt public. Une révision est incluse.
Ce service est idéal pour les petits projets logiciels, les outils open-source, et les développeurs dont la documentation nécessite une mise au propre. Envoyez la page, le public cible, et les détails d’installation fiables pour que les instructions correspondent à votre projet.
J’utilise des outils assistés par IA avec revue. Tous les exemples de code qui ne peuvent pas être testés seront clairement identifiés. Les modifications d’application, le déploiement, la recherche approfondie et l’acceptation garantie des pull-requests ne sont pas inclus dans ce forfait. Toute communication et paiement se font via Fiverr.
Type de document:
Documentation
Langue:
Anglais
Préférence du type de livraison
Veuillez informer le freelance de toute préférence ou préoccupation concernant l'utilisation d'outils d'IA dans la réalisation et/ou la livraison de votre commande.
FAQ
Traduction automatique
De quoi avez-vous besoin avant de commencer ?
Envoyez l’URL de votre dépôt, la page précise, le public cible, et les détails vérifiés d’installation ou d’utilisation. Fournissez les fichiers via Fiverr pour les projets privés ; ne jamais envoyer de mots de passe ou de clés API.
