Je rédigerai la documentation pour développeurs, les docs API et un fichier readme clair

Votre bibliothèque est bonne. Votre README fait trois lignes et une TODO. C’est pourquoi personne ne l’adopte.

Je suis ingénieur logiciel avec plus de 10 ans d’expérience en .NET, Python et DevOps, et j’écris la documentation que j’aimerais que les autres projets aient.

CE QUE VOUS OBTENEZ

- Un README qui permet à quelqu’un de passer du clonage à l’exécution en cinq minutes

- Une référence API écrite à partir de votre code réel, et non devinée à partir des noms

- Des exemples fonctionnels - je teste chacun avant qu’il ne soit livré

- Des sections claires pour l’installation, la configuration et le dépannage

- Markdown, MkDocs, Docusaurus ou fichiers simples

- Anglais ou allemand (natif)

IDÉAL POUR

Les mainteneurs open-source, les équipes SDK et API, les équipes de plateforme interne, et les fondateurs qui ont besoin de documentation avant un lancement ou une levée de fonds.

ENVOYEZ-MOI

Accès au dépôt (lecture suffit), qui est le lecteur - utilisateur final, intégrateur ou collègue - et tout ce qui peut actuellement embrouiller les gens. Vos trois principales questions de support valent plus qu’un cahier des charges.

Je ne stocke pas les identifiants. NDA accepté.

Des documents qui continuent de s’étoffer ? Demandez un abonnement - une quantité fixe de travail de documentation chaque mois, sans nouvelle demande.