docs-guidelines

Maintain repository documentation and markdown trackers with current-state guidelines.

1|Updated Aug 24, 2025
One-click install
npx skills add https://github.com/tomrford/config --skill docs-guidelines
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: docs-guidelines
Source: https://github.com/tomrford/config/tree/main/.agents/skills/docs-guidelines
Command: npx skills add https://github.com/tomrford/config --skill docs-guidelines

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Maintains repository documentation and markdown trackers so they stay concise, current, and authoritative by guiding edits and reviews and removing drift.

Core Features & Use Cases

  • Maintain README.md, AGENTS.md, docs/*.md, onboarding notes, code comments, and other markdown guidance so they reflect current state.
  • Enforce open-items-only trackers, canonical-source examples, and deletion of obsolete notes.
  • Provide a consistent prompt and guidance for contributors during reviews and migrations.

Quick Start

Apply these guidelines when reviewing or editing repository docs to keep them current and authoritative.

Frequently Asked Questions about docs-guidelines

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

FAQPage Schema
How do I keep repository documentation concise and current?

To keep repository documentation concise and current, apply review guidelines that enforce present-state rules, open-items-only trackers, and drift cleanup across markdown files like README.md and docs.

What is documentation drift and how do I clean it up?

Documentation drift occurs when repo docs and code comments no longer reflect the current project state. You clean it up by deleting obsolete notes and enforcing canonical-source examples during markdown reviews.

How do I maintain onboarding notes and AGENTS.md during a project migration?

Maintain onboarding notes and AGENTS.md during migrations by applying consistent review prompts that update markdown guidance to reflect present state and remove deprecated references.

What's the best way to review markdown docs for outdated content?

The best way to review markdown docs for outdated content is enforcing present-state guidelines, checking that examples match canonical sources, and ensuring trackers list only open items.

Do I need any dependencies to enforce documentation guidelines?

No dependencies are required. You can enforce documentation guidelines and drift cleanup rules directly during repository reviews and edits without installing external components.

When should I not use a documentation review guideline approach?

You should not use documentation review guidelines when your repository lacks established markdown files like README.md or docs/*.md, as there is no existing content to review for drift or consistency.