ml-system-hld

Generates vendor-neutral presales high-level design documents with Mermaid diagrams from product descriptions.

3|Updated Jul 24, 2026
One-click install
npx skills add https://github.com/somebodywastoldme/high-level-design-skill --skill ml-system-hld-somebodywastoldme
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: ml-system-hld
Source: https://github.com/somebodywastoldme/high-level-design-skill/tree/main/skills/ml-system-hld
Command: npx skills add https://github.com/somebodywastoldme/high-level-design-skill --skill ml-system-hld-somebodywastoldme

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) and assets (resource) components.

What problem does it solve? Turning a short product or system idea into a credible presales architecture usually requires hours of requirements gathering and diagramming, and unknowns often get presented as facts. This Skill runs a structured discovery interview, separates confirmed requirements from assumptions and open questions, and produces a decision-ready High-Level Design (HLD) document in Ukrainian with a Mermaid diagram. ## Core Features & Use Cases - Structured discovery interview: Asks one question at a time across six categories (business outcome, users, functional scope, scale, data/integrations, security) and labels every claim as Confirmed, Assumption, or Unknown before writing requirements.md. - Vendor-neutral HLD generation: Produces hld.md with one baseline architecture, at most two conditional alternatives, a claim ledger, risks, and a requirements-to-design traceability table, using a catalog of logical components (API Gateway, Event Bus, Vector DB, Feature Store, etc.). - Mermaid diagram composition rules: Enforces a readable 8-16 box diagram with 3-5 subgraphs, left-to-right happy path, and limited exception branches, plus an architecture review checklist before finalizing. - Use Case: A presales engineer receives a one-paragraph idea for a RAG knowledge assistant. The Skill interviews them about scale, access control, and integrations, then outputs a Ukrainian HLD with a rights-filtered retrieval architecture diagram and open questions affecting the estimate. ## Quick Start Ask the assistant to use the ml-system-hld skill to interview you about your system idea and produce a vendor-neutral high-level design document in Ukrainian.

Frequently Asked Questions about ml-system-hld

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I create a high-level design document from a product idea?

Invoke the skill with a short description of your system. It runs a discovery interview across six categories, records confirmed requirements and assumptions in requirements.md, then writes hld.md with a baseline architecture, Mermaid diagram, risks, and open questions.

What architecture diagram format does this skill produce?

Mermaid is the only final diagram format. The skill composes one primary flowchart with 3-5 subgraphs, a left-to-right happy path, and exceptions placed below, adding a second focused view only when the primary diagram exceeds 16 blocks or 2 exception branches.

Does the HLD skill support ML and AI system design?

Yes, it includes dedicated references for ML, AI, RAG, and model-serving systems, with logical components like Vector DB, Feature Store, Model API Proxy, and Re-ranking service, plus worked examples for recommenders, content moderation, and knowledge assistants.

Can I use this skill in Claude, Codex, or Gemini CLI?

Yes, the same skill works across Claude Desktop/Web, Codex, Claude Code, and Gemini CLI on macOS and Windows. Installation differs per host: ZIP upload for Claude, $skill-installer for Codex, plugin or extension install for the CLI tools.

What language is the generated HLD documentation written in?

All generated content is written in Ukrainian, including discovery questions, requirements.md, hld.md, tables, and Mermaid labels. Established technical terms, product names, and code identifiers stay in their conventional form, and another language is used only on explicit request.

When should I not use this HLD design skill?

Avoid it when you need low-level design with implementation details, deployment topology, or cloud-provider-specific configuration. The skill deliberately stays at the HLD level, describing logical components, responsibilities, and boundaries without committing to specific vendors or infrastructure.