Je lirai d'abord votre code, puis rédigerai la documentation
Développeur Python, applications Windows, outils IA
À propos de ce service
La plupart des README sont écrits par la personne qui connaît déjà le fonctionnement du projet, ce qui est précisément la mauvaise personne pour en écrire un.
Je lis votre code en premier, puis j’écris la documentation en me basant sur ce qu’il fait réellement, et non sur ce que vous vous souvenez m’avoir dit à son sujet.
Ce que vous obtenez :
- Un README que quelqu’un peut suivre sans vous poser de questions : ce qu’il est, ce dont il a besoin, comment le faire fonctionner, et ce qui pose problème en premier.
- Un CHANGELOG qui ressemble à une liste de choses différentes, et non à une liste de fichiers modifiés.
- La documentation de l’installation ou de l’API si votre projet en a besoin, avec des commandes testées plutôt qu’avec des suppositions.
- Une note à la fin vous indiquant quelles parties de votre code je n’ai pas pu comprendre, car ce sont généralement celles que vos utilisateurs ne comprendront pas non plus.
Ce que j’apporte : 23 guides techniques sur mon propre site, 46 pages en anglais et en polonais, 53 700 mots. Neuf articles sur HackerNoon, dont un a atteint la première place des tendances et a été repris par la newsletter de l’éditeur.
Anglais ou polonais. Envoyez-moi un dépôt et dites-moi qui doit le lire.
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.
Mon portfolio
FAQ
Traduction automatique
Dois-je vous expliquer mon projet en premier ?
Non. Envoyez le dépôt. Si je ne peux pas comprendre quelque chose à partir du code, c’est une information précieuse, et cela sera dans le rapport.
Pouvez-vous aussi l’écrire en polonais ?
Oui, dans les deux langues, et les deux versions diront la même chose plutôt qu’une traduction qui aurait dévié.
Mon projet est inachevé. Est-ce un problème ?
Non, mais dites-le, et j’écrirai une documentation honnête sur ce qui n’est pas encore construit plutôt que de promettre ce qui ne l’est pas.

