SuperAPI AI 工具集

XIP Writing Reference

写作与研究

查看项目

更新于 10-16 06:13

技能介绍

用途:这是 XerahS Improvement Proposal(XIP)的写作参考,用于产出可执行、结构清晰且符合项目架构的提案。GitHub 是 XIP 的唯一真实来源,docs/proposals/xip/ 仅为生成备份;创建、编辑与同步流程使用 sync-xips,并运行 sync-from-github.ps1 刷新备份。

主要能力与结构:提供头部模板(Status、Created、Updated、Area、Goal),命名约定为 XIPXXXX 加单个空格加描述(4 位补零,不用方括号、冒号或连字符),适用于文件名、GitHub issue 标题与文件内标题。必填章节包括 Overview、Prerequisites、Implementation Phases、Non-Negotiable Rules、Deliverables、Affected Components、Architecture Summary。

写作原则:优先复用现有基础设施(如 WatchFolderManager、TaskManager.StartFileTask、TaskSettings.Clone、UploaderProviderBase);保持平台中立,核心逻辑置于 XerahS.Core 或 XerahS.Common,平台代码留在 Platforms/ 目录;禁止重复上传管线、重复文件处理与设置克隆逻辑;隐私与安全优先,偏好用户显式操作而非自动监控。涉及 Avalonia 绑定时按 Avalonia 语义书写,不要规定 WPF 式 ReflectionBinding。

用法:每个 XIP 对应一个带 xip 标签的 GitHub issue,issue 正文即完整 XIP;编辑后运行同步脚本更新备份。评审前检查头部信息、Overview 的动机、阶段可执行性、代码示例正确性、非协商规则、可验证交付物、受影响组件与架构图,并确认无重复逻辑、平台中立、UI XIP 使用原生绑定语法。

限制:资料未提供该技能的具体安装命令、收费或价格、平台支持范围及实际使用效果,故暂未提供;实际操作需依赖仓库脚本与 GitHub 环境。