Portafolio de redacción técnica

Este es un portafolio dedicado exclusivamente a las muestras relacionadas con software de mi portafolio de Redacción Técnica. Proporciona una mirada exhaustiva a las muestras de documentación de software, todas creadas y publicadas íntegramente en Markdown utilizando Docusaurus. Aquí encontrará ejemplos de guías para desarrolladores, referencias de API e información sobre los flujos de trabajo utilizados para crearlos.

nota

No puedo compartir la mayor parte de mi trabajo debido a acuerdos de confidencialidad (NDA), pero este portafolio incluye contenido original que demuestra mis habilidades y procesos de redacción técnica.

Navegación del portafolio

Guías

• Instalación y aplicación de un tema a Google Chrome
• Uso de Postman para conectarse a la API de Stripe
• Flujo de trabajo de Microsoft Word a GitHub Wiki con Writage
• Enrutamiento de registros de aplicaciones en la nube a una canalización
• 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/informativos

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

Para ver los archivos Markdown originales de estos documentos, diríjase a GitHub.

Flujo de trabajo de documentación

• Redacción con Markdown en VS Code
• Revisión 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

Pila técnica

• Docusaurus: Para generar el sitio estático y la documentación.
• VS Code: Editor principal para todo el contenido.
• Postman: Para pruebas de API y generación de ejemplos de documentación de API.
• Vale: Para la revisión y asegurar el cumplimiento de la guía de estilo.
• Git/GitHub: Para el control de versiones y alojamiento.
• Mermaid Chart: Conversión de código Mermaid en imágenes.
• DeepL MCP: Para la traducción de la documentación a varios idiomas.

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

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