Je vais créer une documentation de codebase orientée développeur à partir de votre dépôt
Développeur d’applications, d’automatisation et d’accessibilité
À propos de ce service
Votre code mérite une documentation claire. Je lis votre dépôt et j’écris une documentation concise orientée développeur à partir de ce que montre le code : README, aperçu de l’architecture, référence API ou modules et, dans le paquet le plus complet, un guide d’intégration pour les nouveaux développeurs.
Ce que vous obtenez : un README avec installation, configuration et utilisation ; un aperçu de l’architecture avec des diagrammes Mermaid légers ; une référence pour les interfaces clés ; et un guide d’intégration (groupe complet de docs uniquement). Livré sous forme de fichiers Markdown dans un dossier docs zippé via Fiverr, en anglais ou en allemand.
Le périmètre est défini par paquet selon la taille du code ou le nombre de modules. Je documente ce qui est évident dans le code et je ne modifie pas votre code. Aucun test d’exécution au-delà de ce que montre la source, donc les comportements peu clairs sont signalés pour que vous les validiez.
Projets pour lesquels vous avez les droits de partage. Veuillez envoyer une archive zip du code. Je n’ai jamais besoin de mots de passe ou de clés, et je laisse de côté les secrets présents dans le code.
Basé en Allemagne et habitué à une collaboration respectueuse de la vie privée. Deutsche Kommunikation jederzeit möglich.
Type de document:
Documentation
Langue:
Anglais
•
Allemand
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
Quelles langues et stacks couvrez-vous ?
La plupart des stacks courantes conviennent, notamment JavaScript, TypeScript, Python, Java, C#, PHP, Go et les frameworks courants. Partagez votre stack technologique et je confirmerai l’adéquation avant de commencer.
Comment sont créés les diagrammes et sous quel format ?
Je crée des diagrammes simples d’architecture et de modules sous forme de code Mermaid intégré dans le Markdown. Ils s’affichent sur GitHub et GitLab et sont faciles à modifier par la suite.
Comment accédez-vous à mon code en toute sécurité ?
Envoyez une archive zip du code via Fiverr. Ne partagez pas de mots de passe, jetons ou clés privées. Je laisse hors de la documentation les secrets présents accidentellement dans le code.
Pouvez-vous mettre à jour la documentation après livraison ?
Oui, vous pouvez commander une mise à jour ou une extension ultérieure. Je peux aligner la nouvelle documentation avec les évolutions du code dans le cadre convenu.
Dois-je partager des données personnelles ou des mots de passe ?
Non. Veuillez partager uniquement des informations liées à l’entreprise. Je n’ai jamais besoin de vos mots de passe personnels.
Pouvons-nous communiquer en allemand ?
Oui, avec plaisir. Je suis basé en Allemagne et peux travailler en allemand ou en anglais. / Ich arbeite auf Deutsch und Englisch.

