Start / Skills / Entwickler-Produktivität / Markdown und Mermaid schreiben (Markdown and Mermaid Writing)
Entwickler-Produktivität

Markdown und Mermaid schreiben (Markdown and Mermaid Writing)

Clayton Young / Superior Byte WorksApache-2.0Sprache des Skills: Englisch
Lizenz geprüftKeine SkripteMittleres Risiko
DemoEchter Lauf · claude-sonnet-5-5 · Oktober 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.

Was es macht

Bietet einen optionalen Hausstil für Markdown-Dokumentation mit Mermaid-Diagrammen, damit Struktur in bearbeitbarem, diff-freundlichem Text steht statt in Screenshots. Es hilft, den passenden Diagrammtyp zu wählen (Flussdiagramm, Sequenz, ER, Zustand, Gantt, C4, Zeitleiste, Mindmap und mehr), und verweist dann auf einen Leitfaden für diesen Typ mit getestetem Beispiel und kopierfertiger Vorlage. Es ergänzt die Barrierefreiheits-Metadaten accTitle und accDescr, hält höchstens ein Emoji pro Knoten und erinnert daran, die Mermaid-Version dort zu prüfen, wo das Dokument angezeigt wird.

Mitgelieferte Referenzen

Ein Markdown-Stilleitfaden, ein Mermaid-Stilleitfaden, Hinweise zum aktuellen Mermaid-Rendering und zum CLI-Export, 21 Diagrammleitfäden und 6 Dokumentvorlagen (Entscheidungsprotokoll, Anleitung, Präsentation, Projektdokumentation, Forschungsarbeit, Statusbericht).

Geeignet für

READMEs, Designdokumente, Methodennotizen und Berichte, bei denen ein Ablauf, ein Datenmodell oder eine Zeitleiste bearbeitbarer Text bleiben soll.

Hinweise & Risiken

Mittleres Risiko: Es schreibt und bearbeitet Markdown-Dateien; es gibt keine Skripte. Der optionale Diagramm-Export installiert per npm das Mermaid-Kommandozeilenwerkzeug und einen Chromium-Browser und braucht dafür eine Netzwerkverbindung. Mermaid-Versionen unterscheiden sich je Plattform, etwa GitHub; prüfen Sie dort, wo Sie veröffentlichen, ob die Diagramme gerendert werden. Die Diagramme im Test wurden nicht gerendert. Der Hausstil (Emoji bei Überschriften zweiter Ebene, ein H1) ist optional: Folgen Sie zuerst dem Stil Ihres Projekts. Diese Kopie ist gekürzt: Sechs der 40 Dateien wurden wegen einer Größenbeschränkung entfernt, vermerkt in SKILL.md. Apache-2.0 von Clayton Young und Superior Byte Works, mit MIT-Integration durch K-Dense; beide Lizenzdateien liegen bei.