Parcourir les catégories
Explorer
Fiverr Pro
Français
$
USD
Je vais documenter votre logiciel avec des diagrammes d'architecture et des docs swagger openapi
Développeur Full Stack
Développeur Full Stack capable d'apprendre et de comprendre pour saisir les problèmes et fournir les solutions dont votre entreprise a besoin.
À propos de ce service
Rendez votre logiciel plus facile à comprendre, à maintenir et à transmettre à d'autres développeurs. Je transforme votre code source et les informations de votre projet en documentation technique claire, en utilisant une analyse assistée par IA et une revue par rapport aux matériaux fournis.
BASE : 1 module, aperçu du projet, structure, guide d'installation et 1 diagramme d'architecture. Livraison en Markdown.
STANDARD : jusqu'à 3 modules, flux de travail clés et modèle de données, jusqu'à 3 diagrammes et Swagger/OpenAPI pour 10 endpoints. Markdown et PDF.
PREMIUM : jusqu'à 6 modules, flux de travail détaillés et modèle de données, jusqu'à 6 diagrammes et OpenAPI pour 25 endpoints. Guide d'installation/déploiement basé sur les informations de votre environnement. Markdown, PDF et sources de diagrammes modifiables.
Un module correspond à une zone fonctionnelle convenue, comme l'authentification ou les paiements. Un endpoint est une méthode HTTP plus la route. Toutes les limites s'appliquent ensemble à un seul dépôt et à une version de code convenue.
Les révisions couvrent les corrections dans le cadre convenu. Les nouvelles fonctionnalités, modifications de code, tests en runtime et mises à jour continues nécessitent un devis séparé. Veuillez me contacter avant de commander pour des projets importants ou complexes.
FAQ
Traduction automatique
De quoi avez-vous besoin pour commencer ?
Fournissez le code source ou le dépôt, le langage/framework, la version de code convenue, le nombre de modules et d'endpoints, le public cible, et les informations disponibles pour l'installation/le déploiement. Supprimez les mots de passe, clés API et données personnelles avant de partager.
Utilisez-vous l'IA pour créer la documentation ?
Oui. J'utilise une analyse assistée par IA pour préparer la documentation et la revoir par rapport au code et aux informations que vous fournissez. Tout comportement manquant ou peu clair sera signalé pour clarification. Les tests en runtime sont un service séparé.
Qu'est-ce qui compte comme un module ou un endpoint ?
Un module est une zone fonctionnelle convenue, comme l'authentification ou les paiements. Un endpoint est une méthode HTTP et une route. Les limites du package s'appliquent ensemble à un seul dépôt et à une version de code. Les systèmes plus grands nécessitent une offre personnalisée.
Qu'est-ce qui est inclus dans les révisions ?
Les révisions couvrent les corrections et clarifications dans le cadre convenu et la version de code. Les nouveaux modules, fonctionnalités, modifications de code, endpoints supplémentaires ou mises à jour continues de la documentation nécessitent un devis séparé.
