Escribiré documentación técnica clara para tu código o API

Un buen código con mala documentación se abandona. Tus usuarios reportan problemas que la documentación debería haber respondido, y tú respondes la misma pregunta cada semana.

Leo tu código actual y escribo documentación que coincide con lo que realmente hace, en lugar de una plantilla genérica con el nombre de tu proyecto pegado.

LO QUE ESCRIBO

README que hacen que alguien pueda ponerlo en marcha en menos de cinco minutos. Referencias de API que cubren cada endpoint, parámetro y error. Guías de configuración que funcionan en una máquina limpia. Ejemplos de código que corren tal cual. Secciones de solución de problemas para los fallos que la gente realmente encuentra. Guías de contribución y registros de cambios.

CÓMO TRABAJO

Primero leo la fuente. Si el código y tu descripción no coinciden, te lo digo. Esa discrepancia suele ser un error que vale la pena conocer, y he encontrado algunos.

FORMATOS

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

LO QUE RECIBES

Documentación que se ajusta a tu repositorio, en tu formato, lista para hacer commit. Archivos fuente incluidos para que puedas mantenerla tú mismo.

Envía un enlace a un repo o tu código y te diré qué necesita realmente.