Community编程与开发github.com

trkbt10/indexion-readme

README 构建——初始化模板结构、从文档注释生成每个包的 README、规划写作任务、根据 doc.json 配置将 docs/ 和包 README 组合成根 README,并使用 `plan drift` 验证编辑。

indexion-readme 是什么?

trkbt10/indexion-readme 是一个专门用于自动构建和生成 README 文件的工具。它的核心功能包括:初始化模板结构、从代码文档注释中自动提取信息并为每个包生成独立的 README、根据 doc.json 配置文件将 docs/ 目录下的文档和各个包的 README 合并为根 README。该工具还支持规划写作任务(plan writing tasks),并通过 `plan drift` 命令来验证编辑是否与计划一致,确保文档的准确性和完整性。它适用于 monorepo 或多包项目,能显著简化文档维护流程。该技能通过清晰的命令和配置驱动,适合集成到开发工作流中。

兼容平台~Claude Code~Codex CLI~Cursor
npx skills add https://github.com/trkbt10/indexion-skills/tree/main/skills/indexion-readme

Installed? Explore more 编程与开发 skills: steipete/bluebubbles, steipete/eightctl, steipete/blucli · View all 6 →

在你喜欢的 AI 中提问

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

文档

indexion-readme 是做什么的?

README 构建——初始化模板结构、从文档注释生成每个包的 README、规划写作任务、根据 doc.json 配置将 docs/ 和包 README 组合成根 README,并使用 plan drift 验证编辑。

Individual skills in this repo

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

trkbt10/indexion-agent-orient

Generate and use a pre-edit structure brief so coding agents learn likely owners, consumer surfaces, and unsafe edit locations before implementing.

trkbt10/indexion-documentation

Documentation analysis — assess coverage, detect code-to-doc drift with plan reconcile, visualize dependencies with doc graph. Answers "what needs docs?" and "are docs still accurate?"

trkbt10/indexion-identity

Detect and review name/content drift in code using `indexion identity audit`, then plan verified renames, moves, folder changes, or splits.

trkbt10/indexion-kgf

Debug and inspect KGF specs — view tokenization results, parse trees, and extracted edges from source files. Use when adding/fixing language support or when indexion's analysis output looks wrong.

trkbt10/indexion-refactor

After writing code, detect and clean up duplication at three levels — copy-paste blocks, cross-package shared code, unnecessary wrappers, and concept-level SoT violations. Detect with indexion, fix, and verify.

trkbt10/indexion-sdd

Generate SDD requirements from RFCs/specs and quantitatively verify implementation conformance. spec draft → spec align → spec verify → automated validation loop with codex/claude. Operate spec-to-impl drift gates as CI checks.

trkbt10/indexion-segment

Split text into contextual chunks for RAG/embedding pipelines. Document segmentation and section extraction using window, tfidf, punctuation, or hybrid strategies chosen by intent.

trkbt10/indexion-wiki

Project wiki lifecycle — create pages, track source changes with ingest, update stale pages, lint structural integrity, detect code-to-doc drift with reconcile, and manage search indexes. A runbook for navigating and maintaining the wiki as an agent.

相关技能