Common Technical Practices logo

Common Technical Practices

OrganizationPopular
TencentBlueKing
common-technical-practices

处理 BK-CI 后端中的横切技术实践时使用,例如 AOP、分布式锁、重试、参数校验、性能监控、定时任务和审计日志。当用户要实现这类框架级实践而不是具体业务功能时优先使用。

Overview

PublisherTencentBlueKing
Repositorybk-ci
Skill namecommon-technical-practices
Stars
2.5K
Forks
524
Bundled files
7
Links
  • Markdown instructions

    A SKILL.md file the model loads on demand, so it only costs tokens when a request actually matches.

  • Works with any LLM

    AI skills are plain Markdown, not provider-specific code, so this works with GPT, Claude, Gemini, Grok, or a local model.

  • 7 bundled files

    Scripts, templates, and references the model can read while it works. Files are read-only and never executed.

  • Open source

    Published by TencentBlueKing on GitHub. Read the source before you install it.

Installation

Install the Common Technical Practices AI skill in TypingMind to use it with any LLM, or drop it into another agent that reads SKILL.md.

1

Install in TypingMind

TypingMind installs a skill straight from its GitHub folder — it reads SKILL.md, bundles the resource files, and stores the result locally.

  1. Open the app and go to Plugins → Skills.
  2. Choose "Install from GitHub".
  3. Paste the skill folder URL below and confirm.
  4. Enable the skill in any chat where you want it available.
Plugins → Skills → Add skill → From GitHub URL, then paste the folder URL and press Continue.
2

Install in another agent

Any agent that reads the Agent Skills format can use this skill — copy the folder into that agent's skills directory.

Claude Code — .claude/skills
git clone --depth 1 https://github.com/TencentBlueKing/bk-ci.git /tmp/bk-ci
mkdir -p .claude/skills
cp -r /tmp/bk-ci/ai/skills/common-technical-practices .claude/skills/common-technical-practices
Restart Claude Code after copying so it picks up the new skill.

Use it in TypingMind

Enable Common Technical Practices in any TypingMind chat and the model takes it from there. Its name and description sit in the system prompt, and the moment a request matches, the model loads the full instructions itself — you never invoke it by hand, and it costs no tokens until it is actually used.

The model loads Common Technical Practices on its own as soon as a request matches it.

Works with any AI model

AI skills are plain Markdown instructions rather than provider-specific code, so Common Technical Practices is not tied to the model it was written for. Install it once in TypingMind and use it with GPT-5, Claude, Gemini, Grok, DeepSeek, Mistral, Llama, or a local model you run yourself — all on your own API keys.

  • Loaded only when it is needed

    The system prompt carries just the name and description. The instructions are fetched on the first matching request, so an idle skill costs nothing.

  • Switch models mid-chat

    Because the skill is instructions rather than code, changing model does not break it — the next model reads the same SKILL.md.

Skill instructions

This is the SKILL.md content the model loads. Read it before installing — a skill is instructions your model will follow.

通用技术实践

适用场景

  • 添加 AOP 切面
  • 使用分布式锁控制并发
  • 配置重试机制与退避策略
  • 做接口参数校验
  • 添加性能监控埋点
  • 编写定时任务
  • 记录审计日志

不适用场景

  • 只是使用某个具体工具类,例如 JWT、表达式解析、线程池工具
  • 只是微服务之间的调用、事件驱动或多环境配置
  • 只是某个模块自己的业务规则

快速指导

  1. 这个 skill 关注的是“框架级横切实践”,不是具体业务模块。
  2. 如果问题更像“给业务逻辑增加一层通用能力”,通常落在这里。
  3. 先按主题进入对应参考文档:
    • AOP:reference/1-aop-aspect.md
    • 分布式锁:reference/2-distributed-lock.md
    • 重试:reference/3-retry-mechanism.md
    • 参数校验:reference/4-parameter-validation.md
    • 性能监控:reference/5-performance-monitoring.md
    • 定时任务:reference/6-scheduled-tasks.md
    • 审计日志:reference/7-audit-logging.md
  4. 如果你要的是“某个现成组件怎么用”,切到 utility-components;如果你要的是“微服务基础能力怎么搭”,切到 microservice-infrastructure

高信号规则

  • AOP、锁、重试、监控、审计这类能力通常跨多个模块复用
  • 这类实践往往和 Spring / 框架集成方式强相关
  • 落地时要优先考虑幂等性、可观测性和并发安全
  • 不要把横切能力写死在单个业务类里

关键陷阱

  • 把工具类使用问题误放到这里
  • 只实现功能,不处理幂等、超时、并发和可观测性
  • 重试、锁、定时任务直接上,而不先判断是否真的需要
  • 把审计日志、监控埋点散落在业务代码里,后续难以维护

延伸阅读

  • AOP:reference/1-aop-aspect.md
  • 分布式锁:reference/2-distributed-lock.md
  • 重试:reference/3-retry-mechanism.md
  • 参数校验:reference/4-parameter-validation.md
  • 性能监控:reference/5-performance-monitoring.md
  • 定时任务:reference/6-scheduled-tasks.md
  • 审计日志:reference/7-audit-logging.md
  • 如果你需要的是工具组件:再看 utility-components
  • 如果你需要的是微服务底座:再看 microservice-infrastructure

Bundled files

The model reads these on demand while the skill is loaded. They are exposed as readable files and are never executed.

Frequently asked questions

What does the Common Technical Practices AI skill do?

处理 BK-CI 后端中的横切技术实践时使用,例如 AOP、分布式锁、重试、参数校验、性能监控、定时任务和审计日志。当用户要实现这类框架级实践而不是具体业务功能时优先使用。

Why use Common Technical Practices on TypingMind?

Because you install it once and use it with any model. Common Technical Practices is plain Markdown rather than provider-specific code, so the same skill runs on GPT-5, Claude, Gemini, Grok, or a local model — and you can switch model mid-chat without it breaking. TypingMind runs on your own API keys, so you pay providers directly instead of a per-seat subscription, and your skills and chats stay in your own storage.

How do I install Common Technical Practices in TypingMind?

Open Plugins → Skills → Install from GitHub in TypingMind and paste https://github.com/TencentBlueKing/bk-ci/tree/master/ai/skills/common-technical-practices. TypingMind reads its SKILL.md and bundles its files and installs it as a skill you can enable per chat.

Which AI models can use Common Technical Practices?

Any model you connect in TypingMind. AI skills are plain Markdown instructions rather than provider-specific code, so GPT, Claude, Gemini, Grok, and local models can all load this skill when a request matches it.

How many AI models can I use with Common Technical Practices?

As many as you like. As long as a model supports skills, you can use Common Technical Practices with it — GPT, Claude, Gemini, Grok, DeepSeek, Mistral, Llama and more — all on TypingMind with your own API keys.

Is the Common Technical Practices AI skill free?

It is published on GitHub by TencentBlueKing. Check the repository for licensing terms. You only pay your own AI provider for the tokens you use.

What are AI skills?

An AI skill is a reusable instruction bundle that teaches an AI model how to do one specific task. It follows the open Agent Skills format: a SKILL.md file with a name and description, plus any scripts, templates or reference files the model may need. The model reads the instructions only when your request matches the skill, so an installed skill costs nothing until it is used.

How are AI skills different from plugins or MCP servers?

A plugin or MCP server gives a model new tools to call — code that runs somewhere and returns a result. An AI skill gives the model knowledge and process instead: how to approach a task, which steps to follow, what good output looks like. Skills are plain Markdown, so they need no server, no API key and no runtime, and they work with any model.

View all

Set up your own AI workspace now

Get notified about new features and future giveaways by subscribing to our newsletter 👇