skills.rest
Ahnd6474
Ahnd6474COMMUNITY
Explore all skills by this author →
GitHub

accelint-readme-writer

Generate or refresh README documentation by analyzing JavaScript/TypeScript codebases.

Updated Mar 24, 2026
Search Tags:#typescript#code analysis#documentation#javascript#readme#humanizer
One-click install
npx skills add https://github.com/Ahnd6474/Jakal-flow --skill accelint-readme-writer-ahnd6474
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: accelint-readme-writer
Source: https://github.com/Ahnd6474/Jakal-flow/tree/main/.skill-staging/skills/accelint-readme-writer
Command: npx skills add https://github.com/Ahnd6474/Jakal-flow --skill accelint-readme-writer-ahnd6474

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

Maintaining README files that accurately reflect a project's API and usage is time‑consuming and error‑prone, leading to outdated documentation that confuses users and contributors.

Core Features & Use Cases

  • Codebase analysis – Recursively parses the source files near the README to discover public exports, examples, and existing documentation.
  • Change detection – Identifies missing, stale, or modified API elements and suggests precise updates.
  • README generation – Produces a complete, human‑friendly README following a prescribed structure, optionally refined by the humanizer sub‑skill.
  • Monorepo support – Scopes analysis to the package that contains the README, handling multi‑package repositories.

Quick Start

Ask the skill to create or update the README for the current package.

Frequently Asked Questions about accelint-readme-writer

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I generate a README from a TypeScript codebase?▼

You can generate a README by having the skill recursively parse your JavaScript or TypeScript source files and package.json to discover public exports, producing a complete README aligned with your actual API.

What is the best way to update stale API documentation in a JavaScript monorepo?▼

Updating stale API documentation in a JavaScript monorepo involves detecting missing or modified API elements and refreshing the package-level README to accurately reflect the current source code exports.

Can I automatically detect missing or modified API elements in my project documentation?▼

Yes, you can automatically detect missing or modified API elements by analyzing the source files near your README, allowing the skill to identify stale documentation and suggest precise updates.

Does the README generation process work with monorepos where the README resides in the package directory?▼

Yes, README generation works with monorepos by scoping the codebase analysis to the specific package directory that contains the README, ensuring the documentation reflects only that package's API.

Do I need a humanizer tool to produce human-sounding README documentation?▼

You do not need a humanizer tool to generate documentation, but the skill can optionally invoke a humanizer sub-skill for final polishing to produce more human-sounding README content.

What are the limitations of automated README generation for JavaScript projects?▼

Automated README generation for JavaScript projects is limited by the accuracy of recursive source parsing and requires reading package.json and source files, meaning undocumented internal logic may not be captured.

Related Skills

Explore More Software Engineering Skills→
tdp1999tdp1999

onboard

Analyze a codebase to extract vision, architecture, and techstack into .context files.

Community
Advanced
Monjyu1101Monjyu1101
1

humanizer

Rewrite text to remove 29 AI-writing patterns and match user voice.

Community
Advanced
DaBigHomieDaBigHomie
1

doc-forensic-inventory

Detect stale documentation references after code or infrastructure changes.

Community
Advanced
nnkiennnnkienn
1

documentation-templates

Generate README, API, code comment, and AI-friendly documentation templates.

Community
Intermediate