code-documentation

Generate LLM-optimized README.md files with frontmatter validation and Mermaid diagrams.

Updated May 6, 2026

Search Tags:#templates #documentation #markdown #readme #diagrams #frontmatter #llm-optimized

Ready to run

npx skills add https://github.com/Abdullahmohammadaref/acar --skill code-documentation-abdullahmohammadaref

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: code-documentation
Source: https://github.com/Abdullahmohammadaref/acar/tree/main/.agents/skills/code-documentation
Command: npx skills add https://github.com/Abdullahmohammadaref/acar --skill code-documentation-abdullahmohammadaref

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This guidance solves the challenge of keeping README.md files for codebase directories consistent, discoverable, and aligned with a formal frontmatter and diagram conventions used by agents.

Core Features & Use Cases

Frontmatter validation: ensures required fields like module, purpose, and last-updated exist and are correctly formatted.
File listings & diagrams: generates a structured file table and Mermaid diagrams to illustrate module structure and data flows.
Templates & references: applies standard README templates and references to enforce uniform documentation across the codebase.

Quick Start

Generate or update the README.md for a target directory using the LLM-optimized conventions described.

Frequently Asked Questions about code-documentation

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

FAQPage Schema

How do I generate an LLM-optimized README for my codebase directories?▼

To generate an LLM-optimized README, apply standardized templates that validate frontmatter, produce a structured files table, and insert Mermaid diagrams for module structure. This ensures your codebase directories remain consistent and quickly discoverable by agents.

What frontmatter fields are required for markdown documentation to be discoverable by agents?▼

Required frontmatter fields for discoverable markdown documentation include module, purpose, and last-updated. Validating these fields ensures your README files meet the standardized conventions required for quick agent navigation and codebase discovery.

How do I add Mermaid diagrams to a README to illustrate module structure and data flows?▼

Adding Mermaid diagrams to a README is handled automatically by applying the standard documentation templates. The process generates the necessary diagram syntax to illustrate module structure and data flows alongside the structured file listings.

What is the best way to standardize README files across a large codebase?▼

The best way to standardize README files across a codebase is to apply uniform documentation templates that enforce frontmatter validation, generate consistent file listings, and include standard references. This maintains consistency across all directories containing code or configuration.

Do I need any specific dependencies to validate markdown frontmatter and generate file tables?▼

No specific dependencies are required to validate markdown frontmatter and generate file tables. The guidance applies standard README templates directly to your target directories to enforce frontmatter rules and structure your documentation conventions.