docs

Audit markdown documentation and execute prioritized writing and link-checking workflows.

Updated Feb 22, 2026

Search Tags:#automation #documentation #markdown #audit #project #link-check

Ready to run

npx skills add https://github.com/marcelocantos/skills --skill docs-marcelocantos

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: docs
Source: https://github.com/marcelocantos/skills/tree/main/skills/docs
Command: npx skills add https://github.com/marcelocantos/skills --skill docs-marcelocantos

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Many projects suffer from incomplete or outdated documentation, which hinders users, contributors, and operators from understanding, using, and maintaining the code effectively.

Core Features & Use Cases

Performs a comprehensive audit of existing documentation across all categories (overview, architecture, API, guides, etc.).
Generates a prioritized, actionable plan that ranks fixes by impact and effort.
Executes the creation, updating, link‑checking, consistency verification, and committing of documentation changes.

Quick Start

Invoke the /docs skill to audit the repository’s documentation and receive a prioritized improvement plan.

Frequently Asked Questions about docs

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

FAQPage Schema

How do I audit existing project documentation across markdown files?▼

To audit project documentation, this skill analyzes existing markdown files across all categories including overviews, architecture, API references, and guides. It then generates a prioritized, actionable improvement plan ranking fixes by impact and effort.

What's the best way to plan and write full project documentation?▼

Writing full project documentation involves generating a prioritized plan from an initial audit, then executing the creation, updating, and consistency verification of markdown files using automated workflows.

How does automated link checking work for markdown documentation?▼

Automated link checking for markdown documentation works by executing validation scripts that verify links during the commit workflow. This ensures consistency and prevents broken references across the project.

Can I use this to generate documentation for any codebase?▼

Yes, you can use this to generate documentation for any codebase where comprehensive documentation is needed to support users, contributors, and operators. It applies to projects requiring overviews, API references, and guides.

What is a documentation audit and when do I need one?▼

A documentation audit is a comprehensive review of existing project files to identify gaps in overviews, API references, and guides. You need one when incomplete or outdated documentation hinders users, contributors, and operators.