Enforce YAML frontmatter and structure for README.md and CLAUDE.md.
npx skills add https://github.com/agentxm/axm --skill documentation-agentxm
Please help me install this Agent Skill. Skill: documentation Source: https://github.com/agentxm/axm/tree/main/.claude/skills/documentation Command: npx skills add https://github.com/agentxm/axm --skill documentation-agentxm
Documentation teams often produce inconsistent README and agent instructions. This Skill defines a standardized approach to documentation across human-facing and agent-facing contexts.
Create or update both README.md and CLAUDE.md in your project following these conventions.
High-intent search queries and answers about installing and using this skill.
To standardize README and agent instruction documentation, apply consistent frontmatter and structure templates to README.md and CLAUDE.md files, eliminating duplication and ensuring consistent human-facing and agent-facing content flow.
Maintaining consistency between human-facing docs and agent instructions requires enforcing a standardized style-guide that defines required YAML frontmatter, recommended document structure, and cross-links to canonical specs for both contexts.
Your project needs YAML frontmatter in CLAUDE.md files if you want to enforce template conformance and standardize agent-facing instruction guides, as it specifies required metadata for consistent documentation practices.
Avoid content duplication in README and CLAUDE files by following a guided content structure that provides recommended sections and flows, alongside anti-pattern guidance and cross-links to canonical specs to prevent redundant explanations.
Agent-facing instruction guides should use a standardized structure that specifies required YAML frontmatter, recommended document flow, and guidance to avoid unnecessary explanations, ensuring agents receive clear and consistent instructions.
You should not use a standardized documentation template if your project does not maintain both human-facing documentation and agent-facing instruction guides, as the conformance rules specifically target README.md and CLAUDE.md files.
riezDefine documentation conventions for CLAUDE.md, README.md, and diff formats.
asteroid-beltGenerate standardized AGENTS.md guides from repository analysis.
cowwocFormat Claude-facing documentation with 110-character wrapping and YAML multi-line syntax.
Andreicr1Generate HTML, Markdown, and PDF API documentation from OpenAPI specs or code comments.
