agentleFS
MsNanMsNan/bishe-doc-skills/skills/system-design/SKILL.md

system-design

Skill0 starsChanged 21 days agoMITView on GitHub

毕设论文系统设计章节(总体架构、功能模块图、E-R 图、数据库表设计、接口设计、关键流程时序图)。写概要设计/详细设计/数据库设计时使用。

64 other projects use a version of this.

Adopted by

Most recently taken up by

Used with

Projects with it also use data-pipelines, data-engineering and 10 more.

Other files people use alongside this one.

Files found in the same public projects as a version of this one, more often than they turn up anywhere else. Each project counts once, large collections count for less, and this file's own repository is left out.
  • YepAPISkill

    data-pipelines

    ETL patterns, cron scheduling, queue-based processing, and batch jobs with Inngest/BullMQ.

    Also in 3 projects that use this

  • travisjneumanSkill

    data-engineering

    ETL/ELT pipelines, data warehousing (BigQuery, Snowflake, Redshift), stream processing (Kafka, Spark Streaming), orchestration (Airflow, Dagster, Prefect), dbt transformations, and data lake architecture. Use when building data pipelines, designing warehouse schemas, or implementing real-time data processing.

    Also in 4 projects that use this

  • wpankSkill

    caching

    Caching strategies, invalidation, eviction policies, HTTP caching, distributed caching, and anti-patterns. Use when designing cache layers, choosing eviction policies, debugging stale data, or optimizing read-heavy workloads.

    Also in 3 projects that use this

  • OpenAISkill

    observability

    Vercel Observability expert guidance — Drains (logs, traces, speed insights, web analytics), Web Analytics, Speed Insights, runtime logs, custom events, OpenTelemetry integration, and monitoring dashboards. Use when instrumenting, debugging, or optimizing application performance and user experience on Vercel.

    Also in 12 projects that use this

  • mmondoraSkill

    infrastructure-as-code

    Infrastructure as Code with Terraform and Pulumi. State management, modularity, drift detection, secrets handling. Use when provisioning cloud resources, writing Terraform/Pulumi modules, or managing infrastructure configuration.

    Also in 3 projects that use this

  • ayudaySkill

    autoplan

    Auto-review pipeline — reads the full CEO, design, and eng review skills from disk and runs them sequentially with auto-decisions using 6 decision principles. Surfaces taste decisions (close approaches, borderline scope, codex disagreements) at a final approval gate. One command, fully reviewed plan out. Use when asked to "auto review", "autoplan", "run all reviews", "review this plan automatically", or "make the decisions for me". Proactively suggest when the user has a plan file and wants to run the full review gauntlet without answering 15-30 intermediate questions.

    Also in 3 projects that use this

The file

Files
SKILL.md

系统设计

4.1 总体架构

  • 一句话说清分层:如「前端 Vue3 + Element Plus,后端 Express/Spring Boot 提供 RESTful 接口,MySQL 存储」。
  • 架构图(mermaid 草稿):表现层 → 业务层 → 数据层,标出鉴权(JWT)位置。
  • 前后端分离要说明跨域、鉴权、文件存储方式。

4.2 功能模块设计

功能结构图(树状):系统 → 前台/后台 → 模块 → 功能点。与需求分析章节的功能点一一对应。

4.3 数据库设计

  1. 概念设计:E-R 图,实体用矩形、属性用椭圆、联系用菱形并标 1:1 / 1:N / M:N。实体太多时画总体 E-R + 局部属性图。
  2. 逻辑设计:E-R 转关系模式,如「用户(用户ID, 用户名, 密码, 角色ID)」,下划线标主键。M:N 联系要拆成中间表。
  3. 物理设计(数据表):每张表一个三线表:
字段名类型长度允许空主键说明
idint11否是主键,自增
  • 表名「表 4-1 用户表(sys_user)」写在表上方;图名写在图下方。
  • 有建表 SQL 时直接从 SQL 生成,字段说明取 COMMENT;不要凭空增加系统里没有的字段。
  • 说明密码字段存哈希(bcrypt 等),不存明文。

4.4 接口设计

表格:接口名称 | 请求方式 | URL | 参数 | 返回 | 说明。统一返回格式写一次即可(如 { code, msg, data })。只列核心接口,完整清单放附录。

4.5 关键流程设计

登录鉴权、下单/审核等 2–3 个流程配时序图(mermaid sequenceDiagram 草稿),说明每一步谁调用谁、失败怎么处理。

注意

  • 设计章节写「怎么设计」,实现章节写「怎么做的 + 截图 + 核心代码」,不要重复。
  • 图表编号按章连续编号,正文里必须引用(「如图 4-2 所示」)。

Download now (ZIP)

Does it work?

Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.

No reviews yet

People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.

  • It worked
  • Partly
  • It didn't
What did you use it for? e.g. Reviewing pull requests in a Rails app

Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.

Your trail

Files you open will collect here, so you can find them again.

Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.

Now do this for your own.

Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.