write-project-readme

To generate a README, this Skill audits your repository contents by scanning project structure and metadata to verify claims against actual code. It requires Python to run the inventory script that maps repository files and produces accurate, evidence-based project documentation.

Yes, you can generate documentation for diverse project types including open-source libraries, internal tools, and agency case studies. The Skill analyzes repository structure and metadata to select the optimal context-aware README profile tailored to the specific audience.

The best way to fix stale documentation is through evidence-based auditing that scans your repository to verify claims against actual code, manifests, and project history rather than relying on outdated descriptions. This ensures your README accurately reflects the current repository state.

Yes, you need Python installed to run the inventory script. The script maps repository files and verifies project claims, serving as the foundational step to generate accurate, evidence-based project documentation.

Evidence-based auditing works by scanning the repository to verify project claims against actual code, manifests, and project history. This technical writing approach ensures the generated README accurately reflects the repository contents rather than relying on outdated or manual descriptions.

You should not use automated README generation if your repository lacks sufficient structure or metadata for the inventory script to analyze. The Skill relies on scanning actual code and manifests to verify claims, meaning empty or chaotic repositories will produce limited documentation results.