Inicio / Skills / Productividad del desarrollador / Markdown and Mermaid Writing
Productividad del desarrollador

Markdown and Mermaid Writing

Clayton Young / Superior Byte WorksApache-2.0Idioma del Skill: Inglés
Licencia verificadaSin scriptsRiesgo medio
DemostraciónEjecución real · claude-sonnet-5-5 · octubre de 2026
I'm documenting a small data pipeline for my team's repo README. Every night a scheduler triggers an ingest job that pulls CSV files from an SFTP server, a validation step checks the schema and moves bad files to a quarantine folder, good files are loaded into a staging table, then a transform job builds the reporting tables, and finally a Slack message is sent. Please write the README section "How the nightly pipeline works": a short intro, a diagram of the flow, and a sequence diagram showing the interaction between the scheduler, the ingest job, the SFTP server, the database and Slack. Our README is viewed on GitHub.
Skill: markdown-mermaid-writing
Read: references/mermaid_style_guide.md
Read: references/diagrams/sequence.md

Here's the section, ready to paste into your README. Both diagrams use standard Mermaid, which GitHub renders natively in light and dark mode.

## How the nightly pipeline works

Every night a scheduler triggers an ingest job. The job pulls CSV files from an SFTP server and checks each file's schema. Files that fail go to a quarantine folder, and files that pass are loaded into a staging table. A transform job then builds the reporting tables from staging, and a Slack message is sent at the end of the run.

### Pipeline flow

```mermaid
flowchart LR
    accTitle: Nightly Pipeline Flow
    accDescr: A scheduler triggers ingest from SFTP. Each CSV is validated. Bad files go to quarantine, good files load into staging, then the transform builds reporting tables and Slack is notified.

    schedule([⏰ Nightly trigger]) --> ingest[📥 Pull CSVs from SFTP]
    ingest --> validate{🔍 Schema valid?}
    validate -->|No| quarantine[🗂️ Move to quarantine]
    validate -->|Yes| staging[💾 Load into staging table]
    staging --> transform[⚙️ Build reporting tables]
    transform --> notify([📤 Send Slack message])
    quarantine --> notify

    classDef good fill:#dcfce7,stroke:#16a34a,stroke-width:2px,color:#14532d
    classDef bad fill:#fee2e2,stroke:#dc2626,stroke-width:2px,color:#7f1d1d

    class staging,transform good
    class quarantine bad
```

### Interaction between components

```mermaid
sequenceDiagram
    accTitle: Nightly Pipeline Sequence
    accDescr: The scheduler starts the ingest job, which downloads files from SFTP, validates each one, quarantines bad files or loads good ones into the database, runs the transform, and posts a summary to Slack.

    participant sched as ⏰ Scheduler
    participant ingest as 📥 Ingest job
    participant sftp as 🖥️ SFTP server
    participant db as 💾 Database
    participant slack as 📤 Slack

    sched->>ingest: Trigger nightly run
    ingest->>sftp: List and download CSV files
    sftp-->>ingest: CSV files

    loop 🔄 Each file
        ingest->>ingest: 🔍 Validate schema
        alt ✅ Schema valid
            ingest->>db: Load into staging table
            db-->>ingest: Rows loaded
        else ❌ Schema invalid
            ingest->>ingest: 🗂️ Move to quarantine folder
        end
    end

    ingest->>db: Run transform (build reporting tables)
    db-->>ingest: Reporting tables updated

    ingest->>slack: 📤 Post run summary
    slack-->>ingest: Message accepted
```

A few details are my assumptions, so please check them against your setup:

  • Who runs what: You didn't say which component runs validation and the transform. I showed the ingest job doing validation and loading, then triggering the transform in the database. If the transform is a separate job, add it as a sixth participant between the database and Slack.
  • Failures: The Slack message is sent after both good and bad files, as in the flow diagram. If it should only fire on success, or should list the quarantined files, say so and I'll adjust both diagrams.
  • Quarantine location: I didn't say whether the folder is on the SFTP server or local storage. Name it in the intro if readers will need to find it.

I couldn't render the diagrams here, but they follow standard Mermaid syntax. You can paste them into mermaid.live, or preview the README on GitHub, to confirm they display.

Real run in an isolated folder with only this skill installed. Only the Skill and Read tools were enabled, so no command was run and no file was written. The scenario is fictional. The diagrams were not rendered in this run: check them in a Mermaid-aware preview such as GitHub or mermaid.live before publishing.

Qué hace

Proporciona un estilo editorial opcional para documentación Markdown con diagramas Mermaid, de modo que la estructura resida en texto editable y fácil de comparar con diff en lugar de capturas de pantalla. Ayuda a elegir el tipo de diagrama adecuado (flowchart, sequence, ER, state, Gantt, C4, timeline, mindmap y más) y luego remite a una guía para ese tipo con un ejemplo probado y una plantilla lista para copiar y pegar. Añade metadatos de accesibilidad accTitle y accDescr, mantiene como máximo un emoji por nodo y recuerda comprobar la versión de Mermaid del lugar donde se mostrará el documento.

Referencias incluidas

Una guía de estilo de Markdown, una guía de estilo de Mermaid, notas sobre el renderizado actual de Mermaid y la exportación por CLI, 21 guías de diagramas y 6 plantillas de documentos (registro de decisiones, guía práctica, presentación, documentación de proyecto, artículo de investigación, informe de estado).

Ideal para

READMEs, documentos de diseño, notas de métodos e informes en los que un flujo de trabajo, un modelo de datos o una línea de tiempo deban seguir siendo texto editable.

Notas y riesgos

Riesgo medio: escribe y edita archivos Markdown; no contiene scripts. La exportación opcional de diagramas usa npm para instalar la herramienta de línea de comandos de Mermaid y un navegador Chromium, lo que requiere conexión de red. Las versiones de Mermaid difieren entre plataformas de alojamiento como GitHub, así que comprueba que los diagramas se rendericen donde los publiques; los diagramas de la prueba no se renderizaron. Su estilo editorial (emoji en los encabezados de nivel dos, un solo H1) es opcional: sigue primero el estilo de tu propio proyecto. Esta copia está recortada: se eliminaron seis de los 40 archivos para ajustarse a un límite de tamaño, como se indica en SKILL.md. Apache-2.0 de Clayton Young y Superior Byte Works, con una integración MIT de K-Dense; se incluyen los archivos de licencia.

SKILL.md original34 archivos en este paquete