Je rédigerai une documentation technique claire pour votre code ou API

Un bon code avec une mauvaise documentation est abandonné. Vos utilisateurs signalent des problèmes que la documentation aurait dû répondre, et vous répondez la même question chaque semaine.

Je lis votre code actuel et rédige une documentation qui correspond à ce qu’il fait réellement, plutôt qu’un modèle générique avec le nom de votre projet collé dessus.

CE QUE J’ÉCRIS

Des README qui permettent à quelqu’un de lancer le projet en moins de cinq minutes. Une référence API couvrant chaque endpoint, paramètre et erreur. Des guides d’installation qui fonctionnent sur une machine propre. Des exemples de code qui s’exécutent tels quels. Des sections de dépannage pour les erreurs rencontrées. Des guides de contribution et des journaux de modifications.

COMMENT JE TRAVAILLE

Je lis d’abord la source. Si le code et votre description ne concordent pas, je vous le dis. Ce décalage est généralement un bug qu’il faut connaître, et j’en ai trouvé quelques-uns.

FORMATS

Markdown, reStructuredText, OpenAPI et Swagger, MkDocs, Docusaurus, HTML simple.

CE QUE VOUS OBTENEZ

Une documentation adaptée à votre dépôt, dans votre format, prête à être validée. Les fichiers sources inclus pour que vous puissiez la maintenir vous-même.

Envoyez un lien vers votre dépôt ou votre code et je vous dirai ce dont il a réellement besoin.