Skip to content

Latest commit

 

History

History
197 lines (129 loc) · 5.51 KB

agent.md

File metadata and controls

197 lines (129 loc) · 5.51 KB

agent.md

本文件用于约束后续 AI 维护 嵌入式Linux常用指令.md 时的整理方式、查重方式和合并规则。

1. 维护目标

  • 保持主文档结构统一、语气一致、排版清晰。
  • 新增内容前必须先查重,避免出现重复命令条目。
  • 如果新内容与已有命令重复,但补充了新的选项、参数、示例或注意事项,应合并到原命令条目中,而不是新增重复章节。

2. 主文档固定结构

主文档使用以下层级:

  • 一级标题:整篇文档标题
  • 二级标题:按主题分类
  • 三级标题:具体命令

每条命令统一使用以下模板:

### `命令`

**作用**  
一句话说明命令用途。

**基本语法**

```bash
命令语法
```

**常用选项**

| 选项 | 说明 |
| --- | --- |
| `-x` | 说明 |

**示例**

```bash
示例命令
```

**补充说明**

- 说明 1
- 说明 2

说明:

  • 如果某条命令没有合适的选项可列,可以省略“常用选项”。
  • 如果某条命令没有额外注意事项,可以省略“补充说明”。
  • 所有命令名称必须使用反引号包裹,例如 ls、sudo、apt install。

3. 查重规则

在新增内容前,先全文搜索以下内容:

  • 命令本名
  • 常见变体
  • 子命令组合
  • 语义相同但写法不同的标题

查重判断规则如下:

3.1 完全重复

满足以下任一情况,视为重复:

  • 已存在同名命令标题,例如已经有 ### \ls`,又新增一个 ### `ls``。
  • 已存在同一命令的同类说明,只是换了说法。
  • 已存在同一命令的同类示例,只是路径、用户名或参数值不同,但知识点一致。

处理方式:

  • 不新增重复标题。
  • 将新增信息合并进原条目中最合适的位置。

3.2 同主命令、同语义

例如:

  • apt install
  • apt remove
  • git clone
  • systemctl restart

这类内容要按“主命令 + 子命令”识别,不要简单只看第一个单词。

处理方式:

  • 如果主文档已经存在同一组命令标题,例如 ### \apt install``,新内容继续补充到该标题下。
  • 如果只有主命令存在,但没有对应子命令,可根据现有结构决定是补充为同一组命令,还是新增单独条目。

3.3 同主题但不是重复

例如:

  • ifconfig 与 ip addr
  • adduser 与 useradd
  • cat 与 less

这类不是重复,而是同主题下的不同命令。

处理方式:

  • 如果主文档已有该主题分类,则把新命令加到对应分类下。
  • 如果新命令只是旧命令的替代方案,可在已有命令的“补充说明”中补一句替代关系。

4. 合并规则

如果发现新内容与已有命令重复,但包含新的有效信息,按以下顺序合并:

  1. 新的用途说明,补到“作用”。
  2. 新的语法格式,补到“基本语法”。
  3. 新的参数、选项,补到“常用选项”表格。
  4. 新的典型示例,补到“示例”代码块。
  5. 新的限制、风险、适用范围,补到“补充说明”。

禁止做法:

  • 为同一个命令新增第二个同名标题。
  • 原有内容不删重,直接把新内容原样贴到后面。
  • 把无关背景、口语化教学废话、截图说明、章节编号残留混入正文。

5. 新增命令的放置规则

  • 优先放入最匹配的已有二级分类。
  • 如果没有合适分类,再新增新的二级分类。
  • 若新命令与最后一个分类最接近,也可以追加在文档后部,但要保持分类标题存在。

当前主文档推荐分类顺序:

  1. 文件与目录操作
  2. 系统信息与帮助
  3. 用户与权限管理
  4. 网络配置与查看
  5. 系统控制
  6. 软件安装相关

6. 内容清洗规则

  • 删除与知识点无关的话术,例如“大家可以试一试”“如图所示”“点击某个按钮”等。
  • 删除截图编号、教材编号、图号引用。
  • 统一用简洁中文说明,不保留原始粘贴里的断句错误。
  • 所有命令示例使用 Markdown 代码块,并标记为 bash。
  • 不堆砌过多示例,每条命令保留最常用、最能说明问题的示例。

7. 特殊规范

7.1 关于 install

如果新增内容里写的是“安装软件”,不要默认归到单独的 install 命令。

先判断语境:

  • 如果是软件包安装,优先归到 apt install。
  • 如果是源码编译后安装,优先归到 make install。
  • 只有在明确是在讲 coreutils 的 install 命令时,才补充到 ### \install``。

7.2 关于 sudo su

如果新增内容中出现 sudo su:

  • 可以保留为示例之一,但不要把它写成唯一推荐方案。
  • 应优先补充说明 sudo -i 或 su - 更规范。

7.3 关于 ifconfig

如果新增内容继续补充 ifconfig:

  • 保留它在嵌入式 Linux 和旧系统中的常见性。
  • 同时可在“补充说明”中提示现代系统常用 ip addr、ip link 替代。

8. 更新流程

每次新增内容时,按以下流程执行:

  1. 先通读主文档相关分类。
  2. 搜索是否已存在相同命令或相近命令。
  3. 判断是“新增条目”还是“补充已有条目”。
  4. 按固定模板整理语言和示例。
  5. 检查 Markdown 层级是否正确。
  6. 检查是否产生重复标题、重复示例或重复说明。

9. 输出要求

完成修改后,应满足以下标准:

  • 标题层级清晰
  • 同类命令集中展示
  • 说明简洁,不夹杂无关上下文
  • 示例可直接复制使用
  • 重复内容已合并
  • 新增内容与旧内容风格一致