需掌握Qoder的Markdown规则驱动机制:一、理解全局与项目级规则文件;二、配置标准化文档模板;三、启用多级继承;四、集成代码块智能渲染指令;五、构建跨文档引用网络。
☞☞☞AI 智能聊天, 问答助手, AI 智能搜索, 多模态理解力帮你轻松跨越从0到1的创作门槛☜☜☜

如果您希望利用 Qoder 的 Markdown 能力高效撰写结构清晰、风格统一、可复用的技术文档,则需掌握其对 Markdown 文件的深度解析与规则驱动机制。以下是实现该目标的具体路径:
一、理解 Qoder 的 Markdown 规则驱动架构
Qoder 将 Markdown 文件作为 AI 行为约束的核心载体,不仅用于呈现内容,更承担定义输出格式、技术栈限制、注释风格与上下文响应逻辑的功能。所有规则文件均以 Markdown 编写,存放于特定目录下,由 Qoder 自动加载并实时生效。
1、全局规则文件 .qoder/rules/global.md 控制所有会话与任务的基础行为边界。
2、项目级规则支持按模块细分,例如在 .qoder/rules/backend/spring.md 中限定 Spring Boot 项目的 Controller 层规范。
3、每个规则文件必须使用标准 Markdown 语法,且禁止嵌入 HTML 标签或 JavaScript 脚本。
二、配置标准化技术文档模板
通过创建专用 Markdown 模板文件,可强制 AI 在生成文档时严格遵循预设结构,包括标题层级、代码块语言标识、参数表格格式及版本标注位置。此类模板适用于 API 文档、部署手册、接口变更日志等高频产出物。
1、在项目根目录下新建 .qoder/skills/doc-template/SKILL.md。
2、在文件中定义文档元信息区块,如:---\ntitle: \"API 接口说明\"\nversion: \"v2.4.0\"\nauthor: \"Qoder Team\"\n---。
3、明确正文结构要求,例如:“所有接口描述必须包含【请求方式】【路径】【请求头】【请求体示例】【响应体示例】【错误码表】六个二级标题”。
三、启用多级文档继承机制
Qoder 支持基于路径匹配的规则继承体系,允许将通用文档规范定义在用户级目录,再通过项目级同名文件进行局部覆盖。这种机制确保团队共享基础模板的同时,保留各项目差异化表达空间。
1、在用户主目录创建 ~/.qoder/skills/docs/standard.md,定义通用术语表与缩略语解释格式。
2、在当前项目中新建 .qoder/skills/docs/project-specific.md,仅补充本项目特有的字段映射关系。
3、当调用文档生成技能时,Qoder 自动合并两者内容,优先采用项目级定义。
四、集成代码块智能渲染指令
Qoder 可识别 Markdown 代码块中的特殊注释指令,从而动态注入语言上下文、执行环境变量或跳过特定片段。该能力使技术文档具备“可运行性”,避免文档与实际代码脱节。
1、在代码块首行添加 ```java --env=prod --include-tests 类型的指令注释。
2、Qoder 在生成文档时自动过滤非生产环境代码,并插入对应单元测试片段。
3、支持的指令包括:--env、--include-tests、--hide-internal、--version=4.0.5。
五、构建跨文档引用网络
借助 Qoder 对 Markdown 内部链接与锚点的增强解析能力,可在多个文档间建立双向引用关系,形成可导航的知识图谱。此功能特别适用于微服务架构下的分布式文档管理。
1、在 A.md 中使用标准语法 [参见权限模型设计](./auth/design.md#section-2) 创建引用。
2、Qoder 在生成 A.md 时自动校验目标文件是否存在,并高亮显示失效链接。
3、在 B.md 中添加反向索引区块,声明 [[ref-from:A.md#section-3]],Qoder 将自动将其纳入 B.md 的“被引用处”列表。

















