Pienso que nunca se debe manejarse la documentaci贸n en espa帽ol. Lo m谩s dif铆cil de completar el paquete es que consiste en diferentes funciones que a su vez son diferentes.
En este sentido se tiene que pensar individualmente en cada una de ella la estructura est谩 bien pero siento que lo laborioso es el hecho de tener que seguir un protocolo r铆gido por ejemplo
-
Script - documento .JS con la funci贸n. Contiene toda la l贸gica, debe incluir sus dependencias. En caso de requerir constantes. Puede usar la variable
this.cdel constructor. Y asignar el valor de la constante en el documento./costant.js -
jsDoc - esto debe describir los par谩metros, retorno de la funci贸n y descripci贸n.
-
.md - La documentaci贸n va en
/docs/api/{nombre}.md/est谩 debe contener lo que hay en el jsDoc. -
Test - las pruebas debe ir en
/test/test_{nombre}/y debe usar mocha.js con describe y it de ser posible usar assert y se debe exponer la mayor cantidad de casos posibles en caso de que la funci贸n tenga par谩metros predeterminados o no debe pruebas para ambos casos.