Back to Details

readmes

Compare original and translation side by side

🇺🇸

Original

English
🇨🇳

Translation

Chinese

/readmes

/readmes

Comprehensive review and update of all README.md files in the meta-repo.
对元仓库中所有README.md文件进行全面审查与更新。

Usage

使用方法

bash
/readmes    # Review all READMEs in ideas/ directory
bash
/readmes    # 审查ideas/目录下的所有README文件

Scope

范围

Includes:
  • ideas/[project]/README.md
    - All project overviews
  • ideas/[project]/apps/*/README.md
    - Multi-app project READMEs
  • Root-level documentation files
Excludes:
  • spaces/
    directory (code repos have their own maintenance)
  • Build artifacts, node_modules, etc.
包含：
  • ideas/[project]/README.md
    - 所有项目概述文档
  • ideas/[project]/apps/*/README.md
    - 多应用项目的README文档
  • 根目录级别的文档文件
排除：
  • spaces/
    目录（代码仓库有独立的维护机制）
  • 构建产物、node_modules等

Execution Flow

执行流程

1. Discover All READMEs

1. 发现所有README文件

bash
Glob: ideas/**/README.md
bash
Glob: ideas/**/README.md

2. Review Each README

2. 审查每个README文件

For each README, technical-writer agent checks:
  • Status accuracy: Matches CLAUDE.md Current Projects?
  • Date accuracy: Is "Last Updated" current?
  • Link validity: Are all links working?
  • Content completeness: Required sections present?
  • Consistency: Formatting matches standards?
技术写手Agent会对每个README文件检查以下内容：
  • 状态准确性：是否与CLAUDE.md中的当前项目信息匹配？
  • 日期准确性："Last Updated"（最后更新日期）是否为最新？
  • 链接有效性：所有链接是否可正常访问？
  • 内容完整性：是否包含所需的所有章节？
  • 一致性：格式是否符合标准？

3. Update READMEs

3. 更新README文件

  • Fix outdated status indicators
  • Update dates to current date
  • Fix broken links
  • Add missing sections
  • Standardize formatting
  • 修复过时的状态标识
  • 将日期更新为当前日期
  • 修复失效链接
  • 添加缺失的章节
  • 统一格式规范

4. Report Results

4. 生成结果报告

Summary includes:
  • READMEs reviewed (count)
  • Updates made (list of files)
  • Issues requiring manual attention
报告摘要包含：
  • 已审查的README文件数量
  • 已更新的文件列表
  • 需要人工处理的问题

What Gets Checked

检查维度

AspectValidation
StatusMatches CLAUDE.md
Dates"Last Updated" is accurate
LinksInternal refs work
StructureHas required sections
ConsistencyFollows template
检查方面验证标准
状态与CLAUDE.md中的信息一致
日期"Last Updated"（最后更新日期）准确无误
链接内部引用可正常访问
结构包含必填章节
一致性遵循模板规范

When to Use

使用场景

  • After major project updates
  • Before project reviews/demos
  • Monthly documentation maintenance
  • After status changes in CLAUDE.md
  • 重大项目更新后
  • 项目评审/演示前
  • 月度文档维护
  • CLAUDE.md中的项目状态变更后

Notes

注意事项

  • Read then write: Agent reads each file before making changes
  • Preserves content: Only updates metadata and known sections
  • Non-destructive: Doesn't remove custom content
  • Idempotent: Safe to run multiple times
  • 先读后写：Agent会先读取文件内容再进行修改
  • 保留内容：仅更新元数据和指定章节
  • 非破坏性：不会删除自定义内容
  • 幂等性：可安全多次运行

Integration

集成流程

Update CLAUDE.md status → /readmes → Verify changes
更新CLAUDE.md中的状态 → /readmes → 验证变更内容