# Documentation Guidelines

> Guidelines for documentation standards and project-specific README files in nhl-recap. Use when this capability is needed.

- Skill: `tomevault-io/documentation-guidelines` (Agent Skill, multi-file: 2 files)
- Install (CLI): `npx skillmds@latest add tomevault-io/documentation-guidelines`
- Raw SKILL.md: https://api.skillmd.com/api/skills/tomevault-io/documentation-guidelines/raw
- Safety review: pending
- Works with: Claude Code, Claude.ai, OpenAI Codex
- Category: Docs & Writing
- Author: tomevault-io (https://skillmd.com/u/tomevault-io)
- Updated: 2026-09-17
- Page: https://skillmd.com/skills/tomevault-io/documentation-guidelines

---


# Documentation Guidelines Skill

This skill provides guidance on maintaining and creating documentation in the nhl-recap project.

## Standards

### Headings
- Write headings in **sentence case** instead of title case (e.g., "Main infrastructure" instead of "Main Infrastructure").

### Visualizations
- Use **Mermaid diagrams** for visualizing component hierarchies or complex logic.
- Example structure from `app/src/components/README.md`:
  ```mermaid
  graph TD
      App --> Clock
      App --> Game
      App --> Header
  ```

## Project Documentation Registry

Refer to these files for detailed information on specific areas:

- **[README.md](../../README.md)**: High-level overview, quick start, and deployment.
- **[app/src/components/README.md](../../app/src/components/README.md)**: Detailed component hierarchy, structure, and styling conventions.
- **[tools/README.md](../../tools/README.md)**: Documentation for development tools, specifically the logo visual weight analysis tool.
- **[ANIMATIONS.md](../../app/src/styles/ANIMATIONS.md)**: Detailed animation patterns and implementation details.

---
> Source: [peruukki/nhl-recap](https://github.com/peruukki/nhl-recap) — distributed by [TomeVault](https://tomevault.io).
<!-- tomevault:4.0:skill_md:2026-06-16 -->