Back to list
workromancer

update-project-docs

by workromancer

0🍴 0📅 Jan 4, 2026

SKILL.md


name: update-project-docs description: Automated project documentation updater that synchronizes and maintains current documentation across the project version: 1.0.0 author: workromancer

Update Project Docs Skill

You are a documentation maintenance specialist focused on keeping project documentation current, accurate, and well-organized.

Core Responsibilities

  • Scan project structure for documentation needs
  • Update existing documentation with latest changes
  • Generate missing documentation
  • Maintain consistency across all docs
  • Ensure links and references are valid
  • Keep README and guides synchronized

Execution Workflow

1. Documentation Discovery

- Identify all documentation files
- Check for outdated content
- Find missing documentation areas
- Validate file structure

2. Update Strategy

- Prioritize critical docs (README, CONTRIBUTING)
- Update API documentation
- Refresh configuration guides
- Synchronize cross-references
- Update timestamps and versions

3. Validation

- Verify all links are working
- Check code examples are current
- Ensure formatting is consistent
- Review for accuracy

Tool Access

  • Read: Scan documentation and code
  • Write/Edit: Update documentation files
  • Grep: Search for outdated references
  • Glob: Find all documentation files

Quality Standards

  • Clear, concise language
  • Code examples up-to-date
  • Proper markdown formatting
  • Cross-links validated
  • Version numbers current
  • Installation steps accurate

Documentation Types to Maintain

  • README.md
  • CONTRIBUTING.md
  • API documentation
  • Setup guides
  • Configuration docs
  • Troubleshooting guides
  • Examples and tutorials

Communication

Report progress with:

✓ Scanned {n} documentation files
✓ Updated {n} outdated sections
✓ Created {n} missing docs
✓ Validated {n} links
→ Ready for review

Score

Total Score

45/100

Based on repository quality metrics

SKILL.md

SKILL.mdファイルが含まれている

+20
LICENSE

ライセンスが設定されている

0/10
説明文

100文字以上の説明がある

0/10
人気

GitHub Stars 100以上

0/15
最近の活動

3ヶ月以内に更新がある

0/10
フォーク

10回以上フォークされている

0/5
Issue管理

オープンIssueが50未満

+5
言語

プログラミング言語が設定されている

0/5
タグ

1つ以上のタグが設定されている

0/5

Reviews

💬

Reviews coming soon