sue-doc-code-consistency
CommunityAudit SUE framework docs for consistency and code alignment.
Education & Research#skill validation#documentation audit#stale doc detection#doc-code consistency#SUE framework#cross-reference check#ML experiment documentation
Authordongzhuoyao
Version1.0.0
Installs0
System Documentation
What problem does it solve?
This Skill eliminates the risk of broken workflows, user errors, and misaligned implementation caused by stale, inconsistent, or incomplete documentation for the DeepResearch SUE scale-up experiment framework.
Core Features & Use Cases
- 13 Focused Audit Functions: Validates skill frontmatter, cross-references, documentation completeness, semantic correctness, stale links, site consistency, contract coverage, version history, workspace docs, doc update triggers, README accuracy, regression detection, and doc-code mismatches.
- Dual Mode Operation: Runs as a subagent of sue-overall-audit for full framework audits, or standalone for targeted documentation checks like verifying docs match code or detecting stale references.
- Use Case: A research team updating SUE skills can run this audit to ensure all documentation reflects current skill behavior, no cross-references are broken, and all canonical contracts are properly documented.
Quick Start
Use the sue-doc-code-consistency skill to run a full documentation audit of the DeepResearch SUE framework and identify all doc-code mismatches and stale references.
Dependency Matrix
Required Modules
None requiredComponents
Standard package💻 Claude Code Installation
Recommended: Let Claude install automatically. Simply copy and paste the text below to Claude Code.
Please help me install this Skill: Name: sue-doc-code-consistency Download link: https://github.com/dongzhuoyao/deepresearch/archive/main.zip#sue-doc-code-consistency Please download this .zip file, extract it, and install it in the .claude/skills/ directory.
Agent Skills Search Helper
Install a tiny helper to your Agent, search and equip skill from 536,000+ vetted skills library on demand.