Results for “readme”

Generates thorough README.md files by deeply exploring a codebase to produce comprehensive project documentation covering local setup, architecture, and deployment.

Generates thorough README.md documentation by exploring a codebase, identifying the tech stack and deployment target, and writing detailed setup, architecture, and deployment sections.

Create professional, visually polished GitHub README files with badges, diagrams, structured sections, and modern markdown design patterns. Use when creating or redesigning a repo's README for maximum GitHub impact.

Generates thorough project documentation by exploring the codebase, identifying the tech stack and deployment target, and writing a comprehensive README.md covering local development, architecture, and production deployment.

Generates comprehensive README.md documentation by exploring the codebase, identifying the tech stack and deployment target, and producing a detailed guide covering local development, architecture, and production deployment.

Synchronizes documentation, READMEs, release notes, and operating docs with current shipped behavior when they have drifted.

Discovers installed skills and generates a catalog in README, JSON, or HTML format, updating documentation and optionally committing changes.

Produces high-quality written knowledge artifacts such as READMEs, guides, API specs, tutorials, runbooks, and wikis, with audience-appropriate structure and accuracy.

You are an expert technical writer creating comprehensive project documentation. Your goal is to write a README.md that is absurdly thorough—the kind of documentation you wish every project had.

You are an expert technical writer creating comprehensive project documentation. Your goal is to write a README.md that is absurdly thorough—the kind of documentation you wish every project had.

You are an expert technical writer creating comprehensive project documentation. Your goal is to write a README.md that is absurdly thorough—the kind of documentation you wish every project had.

You are an expert technical writer creating comprehensive project documentation. Your goal is to write a README.md that is absurdly thorough—the kind of documentation you wish every project had.

You are an expert technical writer creating comprehensive project documentation. Your goal is to write a README.md that is absurdly thorough—the kind of documentation you wish every project had.

You are an expert technical writer creating comprehensive project documentation. Your goal is to write a README.md that is absurdly thorough—the kind of documentation you wish every project had.

You are an expert technical writer creating comprehensive project documentation. Your goal is to write a README.md that is absurdly thorough—the kind of documentation you wish every project had.

You are an expert technical writer creating comprehensive project documentation. Your goal is to write a README.md that is absurdly thorough—the kind of documentation you wish every project had.

You are an expert technical writer creating comprehensive project documentation. Your goal is to write a README.md that is absurdly thorough—the kind of documentation you wish every project had.

You are an expert technical writer creating comprehensive project documentation. Your goal is to write a README.md that is absurdly thorough—the kind of documentation you wish every project had.

You are an expert technical writer creating comprehensive project documentation. Your goal is to write a README.md that is absurdly thorough—the kind of documentation you wish every project had.

You are an expert technical writer creating comprehensive project documentation. Your goal is to write a README.md that is absurdly thorough—the kind of documentation you wish every project had.

You are an expert technical writer creating comprehensive project documentation. Your goal is to write a README.md that is absurdly thorough—the kind of documentation you wish every project had.

You are an expert technical writer creating comprehensive project documentation. Your goal is to write a README.md that is absurdly thorough—the kind of documentation you wish every project had.

Documentation templates and structure guidelines. README, API docs, code comments, and AI-friendly documentation.

Use this skill when the user requests to generate, create, or improve documentation for code, APIs, libraries, repositories, or software projects. Supports README generation, API reference documentation, inline code comments, architecture documentation, changelog generation, and developer guides. Trigger on requests like "document this code", "create a README", "generate API docs", "write developer guide", or when analyzing codebases for documentation purposes.

Write or maintain technical documentation — READMEs, runbooks, API references, architecture docs — that a specific reader can act on without asking follow-ups.

Writing effective project documentation — READMEs, API doc comments, and inline comments that explain why. Use when writing or improving documentation — READMEs, doc comments, inline comments, or when code lacks explanation for non-obvious behavior.

Provides a structured README template for documenting XDG config directories, dotfiles, and script folders, helping users remember the purpose and contents of their local configuration.

Use this skill for README, ADRs, runbooks, changelogs, decision records, operator docs. Trigger when the task involves programming work related to Documentation Adrs, production implementation, audits, debugging, strategy, or validation.

Generates documentation - JSDoc, README sections, API docs, inline comments

Generates and maintains project documentation: Google-style docstrings, README, architecture docs, and ADRs, with a mandatory post-task review gate to keep docs current.