En este artículo, veremos cómo escribir la documentación de un paquete NPM. La documentación es una parte esencial de cualquier paquete NPM porque da una idea sobre el método del paquete y cómo usarlo. Una buena documentación hace que su paquete npm sea un paquete npm popular. La documentación del paquete npm depende de muchos factores, consulte el procedimiento paso a paso.
- NPM: Npm es un administrador de paquetes para descargar el paquete de NodeJS.
- Paquete NPM: el paquete Npm es una forma de agregar dependencia en su base de código NodeJS.
Paso 1: Haz que package.json sea más informativo
Package.json: Es un archivo JSON que contiene toda la información sobre el paquete npm, como quién es el autor del paquete, este paquete depende de qué otro paquete.
El paquete anterior.json contiene muy poca información, por lo que el paquete no aparece en la búsqueda porque la información no es suficiente para la búsqueda.
El archivo package.json que se proporciona a continuación contiene información tan completa.
El archivo package.json depende totalmente de su paquete, pero el formato general también es de este tipo.
Paso 2: Crear ReadMe.MD con gráficos
Readme.MD: Es la parte principal de cualquier documentación, y está escrito en Markdown si quieres aprender haz clic aquí . El markdown también es capaz de contener gráficos y otro contenido multimedia, por lo que si desea que el lector lo entienda mejor, use un gráfico de masa y coloréelo.
A veces, desea que su lector entienda bien, pero no se puede entender solo por escrito, entonces también puede usar imágenes, formas y colores.
Nota: La imagen de abajo es nuestro paquete publicado que se muestra en el paso 1 del archivo package.json
Los dos pasos anteriores son muy simples si desea hacer más documentación, entonces también puede crear una aplicación web.
Paso 3: aplicación web que describe la documentación del paquete npm
Si desea hacer más detalles de su paquete, también puede hacerlo en un sitio web. Te dará más comodidad. Podemos tener un sitio web que describa su paquete, cómo funciona este paquete, etc.
Conclusión: la documentación de cualquier paquete se basa en la idea del desarrollador, y le hemos dado una idea general para crear su propia documentación del paquete npm. Si desea obtener más información sobre la documentación, consulte este artículo. Documentación técnica
Publicación traducida automáticamente
Artículo escrito por mrsuryapratap y traducido por Barcelona Geeks. The original can be accessed here. Licence: CCBY-SA