speclite-shard-doc
按 Markdown 标题把大型 `.md` 文档拆分为有组织的小文件。用于用户要求 shard document、split markdown、拆分文档或文档切片。核心能力:校验来源、选择目标目录、执行分片、核对输出并处理原文件。
- License 许可
- MIT
- 最近更新
- 2026-11-12
- Stars
- ★ 4
- Forks
- 0
01 前言 Front Matter
- name
- speclite-shard-doc
- metadata
- { "author": "fancyliu", "catalog": "speclite", "version": "1.0.0" }
- description
- 按 Markdown 标题把大型 `.md` 文档拆分为有组织的小文件。用于用户要求 shard document、split markdown、拆分文档或文档切片。核心能力:校验来源、选择目标目录、执行分片、核对输出并处理原文件。
- allowed-tools
- Read, Write, Bash, Grep, Glob
02 资源文件 1
- 参考文档CHANGELOG.md432 B
03 SKILL.md 正文
[技能说明]
Speclite Shard Doc 使用 npx @kayvan/markdown-tree-parser 将大型 Markdown 文档按二级标题等结构拆分成更小、更易维护的文件,并生成 index。
[核心能力]
- 源文档校验:确认源路径存在、可访问且为 .md 文件。
- 目标目录选择:通用文档默认使用源文件同名目录;PRD、Epics、Architecture canonical subject document 必须使用源文件所在的 same subject directory。
- 分片执行:运行 npx @kayvan/markdown-tree-parser explode <source> <destination>。
- 输出验证:确认目标目录中生成文件和 index.md。
- 完成报告:报告源文件、目标目录、生成文件数量和工具输出。
- 原文处理:询问删除、归档或保留原文,并执行用户选择。
[执行流程]
1. 获取 source document;未提供时询问用户。
2. 验证文件存在、可访问且扩展名为 .md,否则 HALT。
3. 推导默认目标目录:若 source 是 {planning_artifacts}/prd/prd.md、{planning_artifacts}/epics/epics.md 或 {solutioning_artifacts}/architecture/architecture.md,destination 必须精确为 source parent(same subject directory);其它文档才使用同目录下以 source basename 命名的文件夹。询问用户确认或提供符合该约束的路径。
4. 确认目标目录存在或可创建,且有写权限。
5. 运行 npx @kayvan/markdown-tree-parser explode [source-document] [destination-folder]。
6. 验证输出文件和 index.md;无输出时 HALT。
7. 报告完成结果。
8. 询问用户如何处理原文:delete、move archive、keep,并执行所选操作。
[注意事项]
- 保留原文和分片版本会造成重复和后续加载混乱,应明确提醒用户。
- npx 命令失败或没有生成文件时必须 HALT。
- 删除或移动原文前必须获得用户选择。
- 对 archive 路径,默认使用源文件同目录 archive/ 子目录。
- PRD、Epics、Architecture 的分片必须生成 canonical index.md 并保持在 same subject directory;must not create a shards/ layer。
- 若用户选择保留 canonical whole document,报告 whole+sharded coexistence,并说明后续 consumer invocation 必须通过 speclite resolve artifact-documents ... --selection whole|sharded 显式选择;不得自动择一或混合。
04 同仓库更多 Skills
speclite-dev-story
暂无简介
speclite-code-review-01-reviewer
Fixture-owned installed skill entry for the minimal artifact loop.
speclite-skill-lint
只读检查 Skill 定义;用于 lint skill、check skill、检查技能或评估 Skill 规范。区分基础格式、Codex 适配和 SpecLite 约定,报告证据及未检查项;Agent 定义包转交 speclite-agent-lint。
speclite-skill-creator
创建或迭代 SpecLite workflow Skill;用于 create skill、新建技能、生成技能包或封装工作流。设计入口、辅助资源和验证用例;Agent 定义包转交 speclite-agent-creator。
speclite-html-ppt-generator
生成 SpecLite-owned 单文件 HTML PPT。用于用户要求创建 docs presentation、HTML PPT、网页 slides、Swiss Style deck、杂志风 deck,或其他可直接浏览器打开的介绍/分享型 deck。核心能力:使用本 Skill 内置模板、主题、layout 和 validator 生成横向翻页 HTML,并避免依赖外部个人 skill 路径。
speclite-docs-intro-ppt-creator
生成 SpecLite docs 下的介绍型 HTML PPT。用于用户要求把某个项目体系、系统设计、治理机制、理念或工作流总结成 docs presentation、HTML PPT、网页 slides、介绍 deck。核心能力:限定输出目录、基于事实材料规划叙事、调用 speclite-html-ppt-generator 生成单 HTML deck,并用确定性检查和浏览器抽样收口。