documentation

Map project documentation locations and link key files in a central index.

2|Updated Mar 22, 2026
One-click install
npx skills add https://github.com/hutoroff/squash-bot --skill documentation-hutoroff
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: documentation
Source: https://github.com/hutoroff/squash-bot/tree/main/.claude/skills/documentation
Command: npx skills add https://github.com/hutoroff/squash-bot --skill documentation-hutoroff

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Maps where project documentation lives and what it covers. Reminds to keep docs in sync after service changes.

Core Features & Use Cases

  • Provides a central map of key documentation locations (e.g., README.md, CLAUDE.md, service docs) and their purposes.
  • Helps teams validate documentation coverage during onboarding, refactors, and cross-service updates.
  • Use case: After a service change, quickly verify that all related documents are updated and linked from a central index.

Quick Start

Locate the Documentation Map in the repository and confirm that the listed docs reflect the latest changes.

Frequently Asked Questions about documentation

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

FAQPage Schema
How do I keep project documentation organized and up-to-date after service changes?

To keep project documentation up-to-date after service changes, you need a centralized documentation map that tracks key files and prompts synchronization to ensure all related documents reflect the latest modifications.

What is a documentation map and how does it work for onboarding?

A documentation map is a living index that locates key project documents like README.md and CLAUDE.md, explaining their purposes to help teams validate documentation coverage and streamline the onboarding process.

How do I verify documentation coverage during a project refactor?

You verify documentation coverage during refactoring by checking a central documentation map to confirm all listed service docs and key files accurately reflect the latest codebase changes and remain properly linked.

What's the best way to sync documentation across multiple services?

The best way to sync documentation across services is enforcing a centralized map that links to key files and prompts you to update related documents immediately after implementing service modifications.

When do I need to update the documentation index in my repository?

You need to update the documentation index during maintenance, onboarding, and service updates to ensure all mapped documents stay current, accurately reflecting recent project modifications and remaining properly linked.