← ClaudeAtlas

update-docslisted

Update all project documentation, repository metadata, and progress tracking when the codebase has significantly changed. Handles README (EN/CN), CLAUDE.md, CHANGELOG, pyproject.toml, GitHub About/description/topics, and release notes. CRITICAL: bilingual docs are written independently, NOT translated.
therain2020/therain2020-agent · ★ 0 · AI & Automation · score 75
Install: claude install-skill therain2020/therain2020-agent
# Update Project Documentation Skill When triggered, follow this workflow. Never skip steps. ## Phase 1: Assess Current State 1. Read the current state of all docs that may need updating: - `README.md` — English readme - `README.zh-CN.md` — Chinese readme - `CLAUDE.md` — project instructions for Claude - `CHANGELOG.md` — release history - `pyproject.toml` — version + description 2. Check current test count: `pytest tests/ -q` 3. Check current GitHub repo state: `gh repo view --json description,homepageUrl,topics` 4. Review recent commits since last release to understand what changed. ## Phase 2: Plan Content (Critical Step) **Before writing a single word**, list what needs to change in each doc: | Doc | What changed | Action | |-----|-------------|--------| | README.md | ... | add / rewrite / remove | | README.zh-CN.md | ... | add / rewrite / remove | | CLAUDE.md | ... | update table / test count | | CHANGELOG.md | ... | add new version entry | | pyproject.toml | ... | bump version / update description | | GitHub About | ... | update description + topics | ## Phase 3: Write (Bilingual Rule — Most Important) ### The Golden Rule **English and Chinese READMEs are written INDEPENDENTLY. Never translate.** Translation produces unnatural Chinese that reads like machine output. Signs of bad translation: - English word order forced into Chinese sentences - Overly long sentences with too many clauses - Stiff academic vocabulary where colloquial would be natura