SuperAPI AI 工具集

xip writing (xerahs improvement proposals)

写作与研究

查看项目

更新于 10-16 03:36

技能介绍

用途:本技能指导撰写可执行、结构清晰且契合项目架构的 XerahS 改进提案(XIP),适用于新功能、架构变更与跨平台实现的设计文档编写。

主要能力:

  • 定义 XIP 的必备结构:头部信息(Status、Created、Updated、Area、Goal)、Overview、Prerequisites、Implementation Phases、Non-Negotiable Rules、Deliverables、Affected Components、Architecture Summary 等章节。
  • 规定命名规范:格式为 XIPXXXX Description,编号补零为 4 位,单空格分隔,不加方括号、冒号或连字符;该规范同时适用于 Markdown 文件名、GitHub issue 标题与文件内标题。
  • 给出写作原则:复用既有基础设施(如 WatchFolderManager、TaskManager.StartFileTask、TaskSettings.Clone、UploaderProviderBase、TaskHelpers 等模式)、保持平台中立、禁止重复逻辑、隐私与安全优先、清晰分层。
  • 提供跨平台与 Avalonia 相关规则:核心逻辑放在 XerahS.Core 或 XerahS.Common,平台特定代码留在 Platforms/ 目录;涉及 Avalonia .axaml 绑定时使用 Avalonia 语义,不要规定 {ReflectionBinding #ElementName.Property}。
  • 包含 XIP 演化记录方式、评审清单、常见模式(移动端分享、新上传提供者、跨平台服务)与应避免的反模式。

使用方式:GitHub 是 XIP 的唯一事实来源,tasks/ 文件夹为备份。以 GitHub issue(标签 xip)创建和编辑 XIP,issue 正文即完整 XIP 内容;编辑后运行 sync-xips 技能的 sync-from-github.ps1 脚本刷新 tasks 备份。

限制:资料未提供该技能的安装方式、收费情况与平台支持范围;具体命令仅提及 .ai/skills/sync-xips/scripts/sync-from-github.ps1。