Introducción
Bienvenido a mi portafolio de documentación
Esta sección de mi portafolio de Docs-as-Code proporciona una visión completa de ejemplos de documentación técnica, todos escritos y publicados enteramente en Markdown usando Docusaurus. Aquí encontrarás ejemplos de guías para desarrolladores, referencias a APIs y una visión de los flujos de trabajo utilizados para crearlas.
Navegación
Guías
- 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
- Route Cloud Application Logs Into a Pipeline
- Tutorial: Obtención de datos de objetos
- Tutorial: Envío de una transacción
Referencias API
- Documentación de la API de Stripe
- Pet Store API Documentation
- Ingesta de eventos a través de la API de flujo
- SuiClient: getObject
- SuiClient: multiGetObjects
- SuiClient: getOwnedObjects
Documentos conceptuales/visión general
Para ver los archivos markdown de estos documentos, dirígete a GitHub.
Flujo de trabajo
- Redactando con Markdown en VS Code
- Linting de Markdown con Vale
- Traducción con DeepL
- Creación de diagramas con Mermaid
- Versionado 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 las pruebas de la API y la generación de ejemplos de documentación de la API.
- Vale: Para linting y asegurar la adherencia a la guía de estilo.
- Git/GitHub: Para el control de versiones y el alojamiento.
- Mermaid Chart: Para convertir el código de Mermaid en imágenes.
- DeepL: Para traducir la documentación a varios idiomas.
Esto refleja cómo los equipos profesionales mantienen portales de documentación para desarrolladores como Docusaurus o generadores de sitios estáticos similares.
Cada ejemplo demuestra la creación de documentos de principio a fin: investigación → redacción → revisión → publicación.