repo docs polisher

    1

    Technical writer skill that builds repo docs and READMEs strictly from your actual code and config files.

    $5

    Secure checkout via Stripe

    30-day refund guarantee

    Converts to your local currency at checkout

    Security scanned

    Works with the AI tools you already use

    Claude CodeClaude CodeCursorCursorCodex CLICodex CLIMuseMuseDotsDots+22 more

    repo docs polisher

    Example session with this skill installed

    Audit my current README against this file tree and package.json. The README says to run 'npm start' but I don't see it in my scripts.

    • Read your context and instructions
    • Compiled the repo docs polisher
    • Generated the document

    I have audited your README.md against the provided package.json and file tree. There are discrepancies between your documented commands and the actual project scripts.

    Documentation Audit Report

    ElementREADME ClaimRepo RealityStatus
    Start Commandnpm startScript missing in package.json❌ Broken
    Build Commandnpm run buildesbuild src/index.ts --bundle✅ Matches
    DependenciesRequires redisFound ioredis in dependencies⚠️ Update docs
    Test Suitenpm testNo test script or framework found❌ Missing

    Fact Check & Assumptions

    • Facts: Your package.json only contains build, lint, and dev scripts.

    Assumptions (TO CONFIRM): The dev script (tsx watch src/index.ts) is likely what you intended for the "start" instructions.

    • Questions: Does this project require a local Redis instance, or is it intended to use a cloud provider?

    Proposed Fix: README.md (Installation Section)

    
## Installation

```bash

```bash
npm install

    
## Usage

To start the development server with hot-reloading:

```bash
npm run dev

    To create a production bundle

    npm run build

    
**Next steps**
1. Update the "Usage" section of your README to replace `npm start` with `npm run dev`.
2. Add a `test` script to your `package.json` if you plan to implement unit tests.
3. Confirm if the Redis dependency requires specific environment variables.

    repo-docs-polisher.pdf

    PDF · document

    Generated

    Example file from a real run - the skill writes it into your workspace.

    Connects securely to your tools. The creator never sees your data.

    What you get

    Generate a README based on actual project scripts and file structure.Audit existing docs to identify and fix broken shell commands.Extract API references directly from exported functions and classes.Draft contribution guidelines that reflect the real development workflow.

    About this skill

    The problem

    Great code dies in obscurity because of broken READMEs, missing installation steps, and outdated usage examples. Developers waste time trial-and-erroring commands that no longer exist in the package configuration.

    What it does

    • Generates README.md files based strictly on your package.json, Makefile, and source code.
    • Creates API references with signatures, parameters, and error types extracted from real exports.
    • Audits existing documentation to find broken commands and undocumented flags.
    • Drafts CONTRIBUTING.md files that reflect the actual project structure and development workflow.

    Why this beats prompting it yourself

    Generic LLMs often hallucinate installation commands or configuration flags that don't exist in your project. This skill enforces a strict "no invention" policy, cross-referencing every doc claim against your actual file tree and scripts.

    Use cases

    • Writing a professional README for a new open-source project.
    • Auditing a legacy repo to fix broken setup instructions.
    • Generating internal API documentation for shared utility libraries.
    • Creating honest configuration tables from environment variable usage.

    Known limitations

    Cannot invent license text without user input. Requires access to project configuration files to verify commands.

    How to install

    Works the same in every agent - Claude, Cursor, Codex, Copilot and 20+ more.

    ~30 seconds
    1. 1

      Download the ZIP

      Free skills download straight away. Paid skills unlock right after purchase.

    2. 2

      Unzip into your skills folder

      Every agent reads skills from one folder on your machine. Drop the unzipped folder in there.

    3. 3

      Ask your agent to use it

      Restart the agent if it was already running. It picks the skill up automatically - no config needed.

    Skills folder by agent

    Click the path to copy it. Create the folder if it does not exist yet.

    Reviews

    No reviews yet

    Be one of the first to try it. Every listed skill passes our trust checks below.

    Security scanned

    Passed our 8-point scan before listing

    Fresh listing

    Recently published to Agensi

    30-day refund

    Not a fit? Get your money back

    Trust & safety

    Security scanned

    Verified clean 18 days ago

    • Passed all security checks, Safe to install

    Listed18 days ago

    What's inside

    Frequently Asked Questions