核心用法
wip-readme-format 是一款面向仓库文档管理的格式化工具，主要功能包括：
1. README 重写：wip-readme-format /path/to/repo 自动检测仓库接口类型（CLI、Module、MCP、OC Plugin、Skill、CC Hook），读取 package.json 和 SKILL.md 元数据，按 WIP Computer 标准生成结构化 README
2. 预览模式：--dry-run 参数可在不写入文件的情况下预览输出
3. 验证模式：--check 参数验证现有 README 是否符合标准，返回退出码 0/1
生成内容结构
- WIP Computer 头部标识 + 接口徽章
- 标题 + 标语（Tagline）
- "Teach Your AI" 入门提示块
- 功能特性列表
- 接口覆盖表格（仅限 toolbox 仓库）
- 更多信息链接（技术文档、通用接口规范）
- 许可证声明
安全处理机制
- 技术内容自动迁移至 TECHNICAL.md，原始内容永不删除
显著优点
- 标准化输出：消除 README 格式不一致问题，确保所有 WIP Computer 项目文档风格统一
- AI 优先设计："Teach Your AI" 区块直接面向 LLM 代理优化，提升 AI 理解和调用效率
- 多接口感知：自动识别 6 类接口类型并生成对应徽章和说明
- 零数据丢失：技术内容安全归档至 TECHNICAL.md，避免重写导致的信息损失
- CI/CD 友好：
--check模式支持自动化质量门禁
潜在缺点与局限性
- Node.js 依赖：强制要求 Node.js 18+ 环境，对纯 Python/Rust 项目引入额外运行时
- 标准锁定：严格遵循 WIP Computer 规范，难以适配团队自定义文档风格
- 工具链专属：接口覆盖表格等功能仅对 toolbox 类仓库生效，通用项目受益有限
- 元数据依赖：严重依赖 package.json 和 SKILL.md 的完整性，缺失时生成质量下降
适合人群
- WIP Computer 生态内的项目维护者
- 需要统一管理多仓库文档风格的开发团队
- 追求 AI 代理友好型文档的开发者
- DevOps 工程师（配合 CI 实现文档规范检查）
常规风险
- 版本锁定风险：Node.js 18+ 要求可能限制旧环境部署
- 覆盖风险：虽有 TECHNICAL.md 备份机制，但建议仍对原 README 做版本控制备份
- 生态依赖：深度绑定 WIP Computer 标准，跨生态迁移成本较高
- 维护滞后：标准本身若更新，工具需同步升级否则产生格式漂移