skills.rest
youdotcom-oss
youdotcom-ossOFFICIAL
Explore all skills by this author →
Website𝕏@youdotcomGitHub

documentation

Enforce consistent README and AGENTS.md documentation standards across dx-toolkit packages.

25|6|Updated Sep 23, 2025
Search Tags:#documentation#readme#tsdoc#agents-md#thin-agents
One-click install
npx skills add https://github.com/youdotcom-oss/dx-toolkit --skill documentation-youdotcom-oss
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: documentation
Source: https://github.com/youdotcom-oss/dx-toolkit/tree/main/.agents/skills/documentation
Command: npx skills add https://github.com/youdotcom-oss/dx-toolkit --skill documentation-youdotcom-oss

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

dx-toolkit lacks a unified standard for project documentation; this Skill defines a consistent approach for READMEs and AGENTS.md across packages to improve readability and maintainability.

Core Features & Use Cases

  • Establishes a lightweight, thinned AGENTS.md philosophy that references universal patterns via skills and directs package-specific content.
  • Enforces a minimal frontmatter schema in SKILL.md (name, description, keywords, category) to support discoverability and automated tooling.
  • Use Case: a maintainer updates docs for multiple packages to ensure uniform structure, tone, and quick-start guidance, reducing onboarding time for new contributors.

Quick Start

Review the repository's documentation standards and apply the guidelines to existing or new docs across all packages.

Frequently Asked Questions about documentation

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

FAQPage Schema
How do I standardize documentation across multiple monorepo packages?▼

To standardize documentation across monorepo packages, apply a unified standard for README and AGENTS.md files, ensuring consistent structure, tone, and quick-start guidance to reduce onboarding time for new contributors.

What is a thin AGENTS.md file and when do I need it?▼

A thin AGENTS.md file is a lightweight documentation philosophy that references universal patterns via skills and directs package-specific content, needed when maintaining consistent agent instructions across multiple packages.

Do I need YAML frontmatter in SKILL.md for documentation tools?▼

Yes, you need YAML frontmatter in SKILL.md to declare name, description, keywords, and category, which supports discoverability and automated tooling for your documentation standards.

What's the best way to manage package-specific documentation without duplicating universal patterns?▼

The best way to manage package-specific documentation without duplication is adopting a thin AGENTS.md philosophy that references universal patterns via skills and directs only package-specific content locally.

Can I use these documentation standards for non-monorepo projects?▼

These documentation standards are designed for monorepo documentation practices, guiding structure, tone, and the thin AGENTS.md pattern across packages, but can be adapted for standard project documentation.

Related Skills

Explore More Software Engineering Skills→
shiroginshirogin
1

business-context

Capture project identity, principles, stakeholders, boundaries, and success criteria.

Community
Advanced
m16khbm16khb

factory-validator

Validate generated components against schema and quality metrics with auto-fix suggestions.

Community
Advanced
fabiomilennials1234-a11yfabiomilennials1234-a11y

agent-devex

Generate scripts, templates, and ESLint rules for developer workflows.

Community
Advanced
devbrother2024devbrother2024
88

agents-md

Analyze the project to generate and link root and sub AGENTS.md files, and update CLAUDE.md references.

Community
Advanced