Portafolio de redacción técnica
Este sitio reúne los ejemplos de documentación de software del portafolio de redacción técnica. Docusaurus genera cada página a partir de fuentes en Markdown y MDX. El conjunto abarca guías para desarrolladores, referencias de API, documentación de producto y el flujo de trabajo detrás de cada ejemplo.
Navegación por el portafolio
Explora los ejemplos 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 y luego confirmar revisiones de la wiki con GitHub Desktop.
- 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.
Documentación de búsqueda de empleo de Sweepy
Sweepy consulta sistemas de seguimiento de candidatos y bolsas de empleo, y después clasifica cada oferta frente a un currículum. Esta herramienta de Python es de código abierto e incluye un conjunto de documentación de 13 páginas. Cubre la instalación, la configuración del perfil y la exportación a PDF o CSV. También documenta un servidor del Model Context Protocol (MCP) que ejecuta barridos desde un asistente de IA.
Primeros pasos
- Te presentamos a Sweepy. Explica qué hace un barrido, las cinco etapas de la canalización y cómo Sweepy evalúa un currículum.
- Instalación de Sweepy. Recorre la instalación de Python, Git y el repositorio en Windows, macOS y Linux.
- Ejecutar tu primer barrido. Muestra cómo crear un perfil, iniciar un barrido y leer la salida de progreso.
Cómo leer los resultados
- Cómo interpretar tus resultados. Desglosa la anatomía de las tarjetas en PDF, los porcentajes de compatibilidad, las insignias de solicitud y las columnas de seguimiento del CSV.
- Currículums y porcentajes de compatibilidad. Cubre el formato del currículum para el analizador y la ruta de puntuación desde el currículum hasta el porcentaje de compatibilidad.
- Ejecutar Sweepy desde un asistente de IA con MCP. Conecta el servidor MCP integrado con Antigravity, Claude Desktop o VS Code.
El índice de documentación de Sweepy reúne las páginas de referencia. Abarca comandos, claves de configuración, notas para desarrolladores y la referencia de herramientas. También enumera las fuentes de empleo y las plataformas compatibles.
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 que sigue 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 — observabilidad paralela para la nube y la IA. Guía arquitectónica que compara modelos de enrutamiento de registros para sistemas empresariales.
- El SuiClient. Explica cómo los clientes RPC distribuidos dirigen las 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 una pull request y mensaje de commit de un proyecto de código abierto 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
- Diseño de Artie, un asistente de documentación de IA. 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 revisar las fuentes Markdown sin procesar de estos documentos, consulta 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
- Redacción de documentación de producto para una herramienta de línea de comandos y su servidor MCP junto con el código que los entrega
- 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. Proporciona el entorno principal de edición para 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 canalizaciones de datos.
- Python y MCP. Ejecutan el motor de barrido de Sweepy y el servidor de herramientas que lo conecta con asistentes de IA.
- DeepL y Lara. Automatizan la traducción de documentación a otros idiomas.
Cada página tiene un archivo Markdown o MDX en el mismo repositorio. Compara la salida renderizada con el texto que la generó.
Cada ejemplo sigue el mismo camino, desde la investigación y el borrador hasta las pruebas con resultados reales, la revisión y la publicación.