# Documentation Creation

> Use when creating new repository documentation or agent guides.

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

---


# Documentation Creation

## Scope

Create docs that help future contributors act correctly in this frontend repo.
Prefer short, command-oriented guidance over broad background.

## Required Content

- State the audience and the task the doc supports.
- Reference real repo paths and Makefile targets.
- Explain frontend-specific conventions: React, MUI, Emotion, i18n, testing, and
  Docker-backed commands.
- Add verification steps for any workflow that changes code.

## Markdown Standards

- Keep headings in order.
- Use fenced code blocks with a language.
- Keep lines under the markdownlint limit.
- Avoid bare URLs; use markdown links when links are needed.
- Keep tables narrow enough to pass `make lint-md`.

## Verification

```bash
make format
make lint-md
```

Run `make lint` as the final gate when docs are part of a code change.

## Related Guides

Before applying this skill, confirm the active task against
[../AI-AGENT-GUIDE.md](../AI-AGENT-GUIDE.md) and
[../SKILL-DECISION-GUIDE.md](../SKILL-DECISION-GUIDE.md) so every relevant
skill is consulted.

## Line Length Disclosure

Before presenting changes, check changed text files for lines longer than 100 characters.
If any exist, tell the user each `path:line` and measured character count.
Treat this as disclosure, not failure, unless a project gate fails.

## Supporting Files

- [examples/README.md](examples/README.md): examples of feature and skill docs.
- [reference/doc-templates.md](reference/doc-templates.md): concise templates.
- [reference/verification-checklist.md](reference/verification-checklist.md):
  checks before committing docs.

---
> Source: [VilnaCRM-Org/crm](https://github.com/VilnaCRM-Org/crm) — distributed by [TomeVault](https://tomevault.io).
<!-- tomevault:4.0:skill_md:2026-06-15 -->