Which files does this skill modify?

The skill focuses exclusively on updating README.md and docs/ARCHITECTURE.md based on the current state of the codebase.

How does it ensure code examples in docs are correct?

The skill performs a full reconciliation of PHP blocks in the documentation against the real classes, updating signatures and structures whenever a discrepancy is found.

Will it commit changes to my repository?

No, the skill only modifies the files in your workspace. You retain full control over staging and committing the changes.

Does the skill automatically run my test suite?

Yes, it can run 'make test' and 'make test-e2e' to gather metrics, but it requires user approval and will not run mutation tests like 'make infection' automatically.

README & Architecture Architect

Name: README & Architecture Architect
Author: WarLikeLaux

byWarLikeLaux

•

コンテンツ管理

Automates the synchronization of project documentation with current code state, test metrics, and architectural patterns.

This skill serves as a meticulous technical writer for your codebase, ensuring that README.md and ARCHITECTURE.md never fall out of sync with the actual implementation. It automatically gathers performance and test metrics, validates code snippets against real class signatures, and updates technical stack details. Specifically optimized for complex architectures like DDD and CQRS, it maintains a consistent professional tone and ensures that high-level documentation accurately reflects the underlying structural changes in your project.

主な機能

018 GitHub stars

02Bidirectional synchronization between README.md and ARCHITECTURE.md

03Standardized technical terminology enforcement for Clean Architecture patterns

04Project statistics and tech stack badge updates based on source analysis

05Real-time validation of PHP code examples against actual class signatures

06Automated collection of test coverage and assertion metrics via make commands

ユースケース

01Maintaining consistent technical terminology across multi-file documentation sets

02Ensuring architectural documentation reflects new layers or patterns added to the code

03Refreshing documentation metrics after a major test suite execution or refactor

What are Skills?·How to Install

Install with 🐟 Skill.Fish

npx skillfish add warlikelaux/yii2-book-catalog readme

For use in Claude.ai and ChatGPT

Download Skill