Je rédigerai de la documentation développeur avec guide d'installation d'architecture et référence API
Fondateur chez P and A Dawn Works LLP
À propos de ce service
Une documentation qu’un nouveau ingénieur peut réellement utiliser. Nous lisons votre dépôt et livrons : une vue d’ensemble de l’architecture avec diagrammes (Mermaid, affichés sur GitHub), un guide d’installation permettant à un nouveau collaborateur de démarrer en 30 minutes, une référence API générée à partir du code et vérifiée manuellement, et les cinq domaines les plus risqués du codebase avec ce qu’il faut faire pour chacun.
Livré sous forme de pull requests vers votre dossier docs (Markdown), ou en PDF pour les investisseurs et acheteurs.
Comment cela fonctionne : envoyez le lien du dépôt. Dans les 48 heures, vous obtenez gratuitement un diagramme d’architecture en filigrane d’un service de votre dépôt. Commandez uniquement si cela vous convient.
Prix fixe par résultat, jamais horaire. P & A Dawn travaille, New Delhi.
Type de document:
Documentation
•
Spécifications techniques
Secteur:
Logiciel
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
Quelles langues et cadres pouvez-vous documenter ?
Bases de code JavaScript, TypeScript, Python, Go, Java et C#, avec des API REST ou GraphQL. Les diagrammes utilisent Mermaid et s’affichent sur GitHub.
Ai-je besoin de vous donner l’accès en écriture ?
Non. Un accès en lecture au dépôt suffit. La documentation arrive sous forme de pull request que vous examinez, ou en PDF.
Puis-je voir le travail avant de payer ?
Oui. Envoyez le lien du dépôt et dans les 48 heures vous obtenez gratuitement un diagramme d’architecture en filigrane d’un service, avant toute commande.
