Community写作与编辑github.com

diodesign/diosix-agent-skills

编写和更新 Diosix 文档时应遵循的规则、样式标准和受众指南。在编写新文档、代码变更后更新 CLI 或架构文档,或对照 docs/style-guide.md 审计文档时激活此技能。

diosix-agent-skills 是什么?

该技能为撰写和维护 Diosix 项目文档提供了严格但实用的规则集。它确保 `docs/` 和 `README.md` 中的每个文档页面与 `hypervisor/`、`tools/` 和 `scripts/` 中的实现保持100%同步,并强制遵守 `docs/style-guide.md` 中的样式标准。其核心要求包括使用清晰正确的美式英语、保证文档与代码事实一致(例如 CLI 标志、文件路径、数据结构)、明确针对用户与开发者/维护者双重受众编写,以及遵循严格的格式规范(每行不超过80字符、主动语态、标题使用句首字母大写等)。当意图或术语不明确时,熟练使用该技能的 AI 代理必须停止编写并向首席维护者寻求澄清,从而尽可能减少文档与代码之间的偏差。该技能主要适用于 Claude Code、Cursor 或其他基于 Markdown 的 AI 编码代理,当开发者处理 Diosix 项目的文档变更时,它能显著提升文档质量并降低审核成本。

兼容平台~Claude Code~Codex CLI~Cursor
npx skills add https://github.com/diodesign/diosix-agent-skills/tree/HEAD/documenting-diosix

Installed? Explore more 写作与编辑 skills: steipete/notion, langchain-ai/langchain, bytedance/podcast-generation · View all 6 →

在你喜欢的 AI 中提问

打开一个已预加载此 Agent Skill 的新对话。

文档

撰写 Diosix 文档

docs/ 和 README.md 中的每个文档页面必须与 hypervisor/、tools/ 和 scripts/ 中的实现保持 100% 同步,并且必须遵守 docs/style-guide.md 的规定,以确保文档在第一次审核时就能通过 reviewing-diosix。

核心要求

  1. 清晰、正确的英语散文(基本要求):所有文档必须使用美式英语编写,并确保拼写正确、语法通顺、措辞简洁,同时不牺牲技术清晰度或精确性。
  2. 文档与事实一致:绝不能在 docs/ 中留下过时的 CLI 标志、SBI 函数 ID、ioctl 编号、C 结构体布局(uint64_t 与 unsigned long 的差异)、文件路径或配置键。每次更改行为、CLI 选项、模块化文件路径或配置模式的代码变更,都必须在同一次提交中更新 docs/。
  3. 双重受众设计:明确针对两种不同的受众:
    • 用户(初学者与专家):启动 Diosix、运行引导之旅、使用 dsx 启动客户虚拟机或配置声明式系统/宪章清单的操作人员。
    • 开发者和维护者:构建、测试、调试和扩展 M 模式虚拟机监视器、S 模式 dynarec 和 U 模式工具集的工程师。
  4. 严格遵循样式指南(docs/style-guide.md):
    • 段落、列表项和代码块每行最多 80 个字符(Markdown 表格行和长 URL 除外)。在 Markdown 链接文本中使用文件基名(例如 [S50dropbear](../tools/.../S50dropbear)),使链接行在 80 列内整洁地换行。
    • 使用 主动语态 和 现在时态(例如“虚拟机监视器验证 GPA”,永远不要使用“GPA 将被虚拟机监视器验证”)。
    • 使用 句子式标题(例如 ## 分层客户机模型,不要使用 ## 分层客户模型)。
    • 在 每个页面首次出现时 拼写出缩写(例如 Supervisor Binary Interface (SBI)),之后只使用缩写(SBI)。
    • 严格 为连续的多步骤流程使用编号列表,为非顺序项目使用无序列表。
  5. 不确定时,停止并询问首席维护者:如果预期行为、术语或受众范围不明确,应当停止并询问首席维护者以获得澄清,而不是猜测或编造细节。

重点参考指南

在起草或编辑文档之前,请先阅读相关的参考文件:

  • 样式与规范术语:英语语法/拼写标准、80 列换行规则、缩写扩展规则以及规范的硬件/虚拟化定义(Host build machine、Host hardware、Target platform、HPA、GPA、GVA、CID)。
  • 双重受众与文档地图:为初学者/专家用户与维护者定制内容、将代码变更映射到具体的 docs/*.md 文件,以及记录测试约定。

Individual skills in this repo

This repo contains 2 individual skills — each has its own dedicated page.

相关技能