Introducción

Bienvenido a mi portafolio de documentación

Esta sección de mi portafolio de redacción técnica ofrece una visión completa de ejemplos de documentación de software, todos ellos creados y publicados íntegramente en Markdown utilizando Docusaurus. Aquí encontrarás ejemplos de guías para desarrolladores, referencias de API e información sobre los flujos de trabajo utilizados para crearlos.

Guías de navegación

• Instalación y aplicación de un tema en Google Chrome
• Uso de Postman para conectarse a la API de Stripe
• Flujo de trabajo de Microsoft Word a GitHub Wiki con Writage
• Enrutar registros de aplicaciones en la nube a un pipeline
• Tutorial: Obtención de datos de objetos
• Tutorial: Envío de una transacción

Referencias de API

• Documentación de la API de Stripe
• Documentación de la API de Pet Store
• Ingesta de eventos a través de la API de streaming
• SuiClient: getObject
• SuiClient: multiGetObjects
• SuiClient: getOwnedObjects

Documentos conceptuales/generales

• Flujos de eventos y canalizaciones de observabilidad
• Antes de empezar
• La arquitectura de SuiClient

Para ver los archivos Markdown sin procesar de estos documentos, dirígete a GitHub.

Flujo de trabajo

• Redacción con Markdown en VS Code
• Linting de Markdown con Vale
• Traducción con DeepL
• Creación de diagramas con Mermaid
• Control de versiones de documentos con Git
• Validación de API con Postman y Swagger/OpenAPI
• Publicación con Docusaurus

Herramientas

• Docusaurus: para generar el sitio estático y la documentación.
• VS Code: editor principal para todo el contenido.
• Postman: para probar la API y generar ejemplos de documentación de la API.
• Vale: para depurar y garantizar el cumplimiento de la guía de estilo.
• Git/GitHub: para el control de versiones y el alojamiento.
• Mermaid Chart: para convertir código Mermaid en imágenes.
• DeepL MCP: para traducir la documentación a varios idiomas.

Esto refleja la forma en que los equipos profesionales mantienen los portales de documentación para desarrolladores, como Docusaurus o generadores de sitios estáticos similares.

Cada pieza muestra la creación de documentación de principio a fin: investigación → redacción → revisión → publicación.