Module Governance logo

Module Governance

Community
qshanx
module-governance

为新业务模块建档、补齐已有模块约定或维护模块边界变化。用户提出新建核心模块、补齐模块文档或调整模块职责时可按意图选择,无须点名 Skill;区分项目级与模块级 AGENTS,关联 CONTEXT、接口与决策,复用现有治理 Skills。普通 Bug、样式修改和纯审计不启动建档。

Overview

Publisherqshanx
Repositorydocs-governance
Skill namemodule-governance
Stars
228
Forks
4
Bundled files
1
LicenseMIT
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.

  • 1 bundled files

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

  • Open source

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

Installation

Install the Module Governance 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.
    https://github.com/qshanx/docs-governance/tree/main/skills/documentation/module-governance
  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/qshanx/docs-governance.git /tmp/docs-governance
mkdir -p .claude/skills
cp -r /tmp/docs-governance/skills/documentation/module-governance .claude/skills/module-governance
Restart Claude Code after copying so it picks up the new skill.

Use it in TypingMind

Enable Module Governance 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 Module Governance 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 Module Governance 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.

模块治理

用户可以点名,也可以用自然语言提出模块任务,由 Agent 按意图选择。不安装后台触发器。识别到任务不等于扩大授权:只在当前用户要求涵盖的范围内写文档;业务代码、业务取舍、提交与推送分别沿用当前授权。

触发与不触发

用户场景行动
“新增库存管理模块”且要求实施进入本流程,先识别边界和已有知识;必要文档作为模块任务的一部分,不要求用户记住 Skill 名称
“补齐订单模块文档/维护模块职责”或点名 Skill在授权范围内建档或维护
“考虑拆一个支付模块,你怎么看”只读分析,不创建文件,不把讨论当实现批准
普通 Bug、样式、内部重构且约定未变不进入建档,读取适用规则即可
纯审计发现缺失报告缺口,不转为写入;用户已同时授权补齐模块文档时才进入修复
setup/收尾仅当本次授权明确包含模块建档或约定维护时调用;不能为了模板完整批量生成

“新增模块”如果只是普通目录/UI 组件,则沿用父级约定;不能靠关键词判断。识别不明先只读定位,只有影响边界或写入范围的关键歧义才询问。

使用场景

  • “使用 module-governance,为新建的库存模块建立开发约定。”
  • “用模块治理补齐现有订单模块的入口,复用已有术语和接口。”
  • “用模块治理维护已确认的库存/订单职责调整。”

只问如何划分时给方案;只有文档写入在授权内才落盘。普通 Bug、样式修改、单个页面或公共按钮不因此建一套文档;纯架构审查直接使用 architecture-docs。

执行顺序

  1. 读取项目并界定对象。 读取项目/父级入口、现有模块导航及相关需求,区分新建、补齐、变更维护和只读咨询。模块名称和目录沿用已有约定;通过职责、状态和消费者识别边界,不把目录当作限界上下文。资料不够时列出待确认项,不批量生成空文件。

  2. 明确两级入口。 项目级入口保留全局约束、模块导航和跨模块协作规则;模块入口只补本模块职责/非职责、状态归属、公共接口指针、专属约束与验证入口。执行 agent-entrypoints 的主源选择和八项规范;沿用已有 CLAUDE 主源时不强制改名。模块规则不能自行解除全局约束。

    先检查现有根入口/架构主记录是否已明确覆盖该模块。没有相对父级新增规则且覆盖充分时,直接返回复用路径,不为核心模块身份强制新增局部 AGENTS;项目已有明确局部入口要求时遵从该要求。两级描述的是规则作用域,不是文件数量指标。

  3. 澄清并关联领域语言。 执行 domain-modeling,以场景与代码澄清术语,确认一项就维护对应 CONTEXT。AGENTS 只引用定义,不复制词汇表。前后端属于同一业务上下文时共用术语;UI 专属开发约束可以分层记录,不按每个页面建 CONTEXT。

  4. 按变化调用专项方法。 职责与依赖核对用 architecture-docs;接口入口和唯一机器定义用 contract-first;难回退决策复用 domain-modeling。已有模块变更先用 change-impact 核对影响。只读取适用方法,不默认执行整套开发或重构。

  5. 更新最小文档集合。 获准后就地补齐模块入口和必要 CONTEXT,项目已有 MAP/入口只登记真实路径及适用范围。保留已有契约与 ADR,正文不复制。内部实现变化不影响约定时无需改文档,给出依据;业务选择冲突时保留双方证据,等待确认,不改规则迁就代码。

  6. 验证与交接。 复用 agent-entrypoints 的入口验证及 architecture-docs 的边界核对;用 docs-maintenance 同步实际受影响引用。报告采用的主记录、变化、检查结果和未验证项。现有代码缺失时标“已确认设计、代码未验证”,不能声称文档已与代码一致。

生成或修改文档后,按每份引用文档所在目录解析相对链接,不按终端工作目录或凭层级印象计算。复用插件已有检查:python3 <插件目录>/scripts/audit-docs.py --root <目标项目根目录> --scope artifacts;插件目录由当前 Skill 的真实安装路径确定。检查包含模块 AGENTS、CONTEXT 及本次变更的项目导航,核对输出中的 Markdown 链接结果与退出码。出现断链时修正引用后重跑,不创建空文件凑通过;脚本不可用或扫描未覆盖目标文件时明确记录未验证,不以业务测试通过替代链接检查。路径存在后仍核对链接是否指向预期的项目/模块规则或接口,不能把同名但错误的目标当作正确。

交付边界

交付的是可供后续开发读取的模块规则和知识入口,不是完成业务实现或 DDD 改造。项目入口可以要求开发前读适用的项目/模块 AGENTS、CONTEXT 及相关契约,跨模块读取双方;这与自动调用本 Skill 是两件事。不要在入口复制本流程,也不承诺宿主自动加载所有子目录。

完成需满足:已授权范围的主记录及导航可找到、项目与模块规则不重复或冲突、术语有明确上下文、接口有唯一来源,检查有证据或明确缺口。没有新增领域语言时可引用已有 CONTEXT,不为凑“两份文件”创建空壳。

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 Module Governance AI skill do?

为新业务模块建档、补齐已有模块约定或维护模块边界变化。用户提出新建核心模块、补齐模块文档或调整模块职责时可按意图选择,无须点名 Skill;区分项目级与模块级 AGENTS,关联 CONTEXT、接口与决策,复用现有治理 Skills。普通 Bug、样式修改和纯审计不启动建档。

Why use Module Governance on TypingMind?

Because you install it once and use it with any model. Module Governance 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 Module Governance in TypingMind?

Open Plugins → Skills → Install from GitHub in TypingMind and paste https://github.com/qshanx/docs-governance/tree/main/skills/documentation/module-governance. 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 Module Governance?

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 Module Governance?

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

Is the Module Governance AI skill free?

Yes. It is published on GitHub by qshanx under the MIT license. 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 👇