shirushi

一个用于管理和验证Git仓库中文档ID的系统,确保ID的一致性和不可变性。

安装使用

复制下面这段提示词发给你的 AI(Claude / Cursor / TRAE / Codex / WorkBuddy 等),它会自动帮你完成安装:

帮我安装这个 AI Skill:shirushi。
它的用途是:一个用于管理和验证Git仓库中文档ID的系统,确保ID的一致性和不可变性。
完整的 Skill 内容见:https://321skill.com/skills/shirushi/raw/index.md
请读取该页面内容,如果是 SKILL.md 格式直接安装,如果是 README 提炼核心 prompt 后安装。

提示词包含完整的 Skill 内容链接,AI 读取后即可完成安装。你也可以 查看完整内容 确认无误。

使用示例

“请帮我检查`docs/`目录下所有技术文档的ID是否符合规范,并对比`main`分支看看有没有ID被意外修改。” 它会引导你运行 `shirushi lint --base origin/main` 命令,扫描文档并输出详细的验证报告,指出缺失、重复或被篡改的ID,确保文档标识的完整性和一致性。

介绍

Shirushi 是一个专为Git仓库设计的文档ID管理与验证系统。它解决了团队协作中,技术文档、设计稿、备忘录等文件因缺乏统一标识而导致的版本混乱、引用错误和难以追踪的问题。

通过定义灵活的ID格式模板(如“{组件}-{类型}-{年份}-{流水号}-{校验码}”),Shirushi能够为Markdown和YAML文件自动生成或验证唯一、结构化的文档ID。它深度集成Git,能够对比不同版本间的ID变化,在CI/CD流程中作为质量关卡,有效防止ID被篡改、重复或遗漏。

该工具非常适合需要严格管理大量技术文档、设计规范或项目资产的开发团队、文档工程师和项目经理。它尤其适用于开源项目、大型企业级应用或任何对文档可追溯性有高要求的场景。

使用建议:建议在项目初期就引入Shirushi并制定好ID规范。注意,其核心是ID的“管理”和“验证”,而非文档内容的生成或编辑。对于小型或个人项目,其配置可能略显繁重,但对于中大型团队,它能显著提升文档管理的规范性和效率。

核心特点

与通用的文档生成或格式化工具不同,Shirushi专注于文档“身份标识”的生命周期管理,通过Git感知和CI集成,强制保证ID的不可变性,这是其区别于简单ID生成器的核心。它提供了维度化、可配置的ID模板(如枚举、序列号、校验码),并能基于文件路径、类型等自动选择维度值,实现了高度定制化的ID体系。

注意事项

不适合用于管理非文本二进制文件(如图片、视频)的ID,或不需要严格版本控制和唯一性标识的小型个人笔记项目。

常见问题

Shirushi 能自动为已有文档添加ID吗?

Shirushi 主要功能是验证和索引管理。为已有文档添加ID通常需要结合脚本或手动操作,然后由Shirushi进行校验。

它支持哪些文件格式?

目前主要支持Markdown(通过Front Matter)和YAML文件。可以通过配置 glob 模式来指定需要管理的文件。

给 AI 助手的安装指引

如果你的 AI 编程助手(Claude Code、Cursor、TRAE 等)能看到这个页面,把下面这段发给它即可自动完成安装:

请访问 https://321skill.com/skills/shirushi/raw/index.md 读取 shirushi 的原始 Skill 定义(Markdown 格式),按其中说明在我的环境里完成安装和配置。