What are README exemplars?

Exemplars are high-quality, third-party repositories discovered via web search that demonstrate best-in-class documentation patterns for your specific technology stack.

How does the skill determine the project's tech stack?

The skill executes a language audit using repository heuristics, scanning manifest files and file counts to identify both primary and secondary languages influencing the project.

Does this skill support internal documentation links?

Yes, it specifically maps internal files, specifications, and wikis to the README structure to ensure context-sensitive linking across your repository.

How does it ensure the documentation is accurate?

The skill uses an evidence-based approach, only adding tables, diagrams, or claims that originate from verified repository assets and benchmarks, avoiding speculative content.

README Architect

Name: README Architect
Author: athola

byathola

•

Learning & Documentation

Refreshes and optimizes repository documentation using language-aware research and industry-standard structural patterns.

The README Architect skill automates the creation of professional-grade project documentation by combining local repository analysis with global best practices. It conducts a thorough audit of your codebase to identify tech stacks, researches high-performing 'exemplar' repositories for inspiration, and restructures your README to include critical sections like quickstarts, architectural highlights, and internal documentation links. By grounding every update in reproducible evidence and existing project assets, it ensures your documentation remains accurate, informative, and free from marketing fluff.

Key Features

01Exemplar research to integrate industry-leading documentation patterns

02Reproducible verification reporting and link clarity checks

03Automated language audit to detect primary and secondary tech stacks

04Evidence-based content generation referencing actual repo benchmarks

0510 GitHub stars

06Structural alignment with internal docs, specs, and wiki links

Use Cases

01Bootstrapping a comprehensive README for new repository launches

02Modernizing legacy documentation to meet modern open-source standards

03Consolidating fragmented project notes into a unified documentation entry point

What are Skills?·How to Install

Install with 🐟 Skill.Fish

npx skillfish add athola/claude-night-market update-readme

For use in Claude.ai and ChatGPT

Download Skill