Portafolio de redacción técnica
Este es un portafolio dedicado exclusivamente a los ejemplos relacionados con el software de mi portafolio de redacción técnica. Ofrece una visión completa de ejemplos de documentación de software, todos ellos redactados 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.
Navegación por el portafolio
Explora los ejemplos de documentación organizados por tipo de entregable y dominio:
Guías de desarrollo y del sistema
- Instalación y aplicación de un tema en Google Chrome. Una guía paso a paso para la personalización del navegador con pestañas de interfaz interactivas y un diseño adaptable.
- Flujo de trabajo de Microsoft Word a GitHub Wiki con Writage. Una guía para redactar en Markdown desde Word, clonar wikis con GitHub Desktop y publicar revisiones.
- Uso de Postman para conectarse a la API de Stripe. Una guía para autenticarse y realizar solicitudes de API en Postman.
- Crear un servidor de simulación de Postman. Un tutorial práctico para configurar servidores simulados con el fin de probar integraciones de webhooks y esquemas de API.
- Enviar los registros de una aplicación en la nube a un pipeline. Un procedimiento operativo para ingerir y filtrar la telemetría de aplicaciones en la nube.
- Cómo obtener datos de objetos. Un tutorial que explica las consultas de lectura RPC con el SDK de TypeScript para Sui.
- Uso de operaciones de escritura para enviar una transacción. Una guía para desarrolladores sobre cómo firmar y transmitir transacciones programables.
Referencias de la API
- Documentación de la API de Stripe. Documentación de referencia de API para fintech e infraestructura de pagos.
- Documentación de la API de Pet Store. Referencia modular de API REST diseñada según la especificación OpenAPI 3.0.
- API de ingesta de registros de Datadog. Referencia de API de streaming para enviar datos de telemetría por lotes.
- Referencia del SDK de TypeScript para Sui:
Arquitectura y documentación conceptual
- Introducción a la API de Stripe. Visión general conceptual de la infraestructura financiera, entidades clave y autenticación.
- Introducción a la API de Pet Store. Descripción general del servicio REST de Petstore con Swagger/OpenAPI y esquemas de autenticación.
- Flujos de eventos y canalizaciones de observabilidad. Visión arquitectónica del procesamiento de flujos, enrutamiento perimetral y transformación de datos.
- Antes de empezar con las canalizaciones de observabilidad. Guía arquitectónica que compara los paradigmas de enrutamiento de registros para sistemas empresariales.
- La arquitectura de SuiClient. Modelo mental que explica cómo los clientes RPC distribuidos orquestan consultas de estado.
Mensajes de confirmación y solicitudes de incorporación de cambios
- Corrección de matrices ordenadas por F en NumPy. Descripción de pull request de código abierto y mensaje de commit que resuelven problemas de disposición de memoria en matrices.
- Diferenciación a través de ak.mean en JAX. Documentación y mensaje de commit que explican el soporte de diferenciación automática en Awkward Array.
Casos prácticos
- Caso de estudio del asistente de IA Ask Artie. Un caso de estudio de ingeniería que analiza ingeniería de prompts, seguridad según OWASP LLM y arquitectura de recuperación RAG.
Para inspeccionar los archivos fuente de Markdown sin procesar de estos documentos, visita el repositorio de GitHub.
Flujo de trabajo de «documentación como código»
- Redacción en Markdown y MDX con VS Code y Antigravity
- Verificación de estilo y prosa con Vale
- Internacionalización y traducción con DeepL y Lara
- Creación de diagramas de arquitectura del sistema con Mermaid
- Control de versiones y revisión colaborativa de código con Git y GitHub
- Exploración y validación de API con Postman y Swagger/OpenAPI
- Despliegue continuo con Docusaurus
Pila tecnológica
- Docusaurus. Genera sitios web estáticos, barras laterales de navegación y versiones localizadas.
- VS Code. Funciona como editor principal para la redacción en Markdown y MDX.
- Postman. Valida puntos finales de API y genera ejemplos de solicitudes y respuestas.
- Vale. Revisa la prosa técnica para cumplir con las directrices de documentación para desarrolladores de Google.
- Git y GitHub. Gestiona el control de versiones por ramas y el despliegue del sitio.
- Mermaid. Renderiza diagramas de flujo y diagramas de arquitectura de canalizaciones de datos.
- DeepL y Lara. Automatizan la traducción de documentación a múltiples idiomas.
Este entorno refleja los portales de desarrollo en producción de las empresas modernas de ingeniería.
Cada muestra refleja el proceso integral de creación de documentación: investigación, redacción, pruebas, revisión y publicación.