smithery.ai

readme-gen

Створення високорівневої документації для проектів на базі Vanilla Vite Multi-Page App. Сфокусовано на те?

First seen Apr 14, 2026

Installation

$ npx skills add https://smithery.ai

Similar popular skills

Related neighbors and high-traction skills in the same topics — useful to compare before installing.

Also in this package

Other skills from smithery.ai · top by installs.

npx skills add https://smithery.ai

Browse all from smithery.ai

More details

Agent compatibility

Declared targets from SKILL.md / docs. Unmarked agents are not listed — the skill may still install via the CLI.

Claude Code Not declared
Cursor Not declared
Codex Not declared
GitHub Copilot Not declared
Windsurf Not declared
Gemini CLI Not declared
Cline Not declared
OpenCode Not declared

Skill metadata

Parsed from SKILL.md frontmatter.

Version1.0.0

Package contents

Files included with this skill beyond the listing page.

  • skill md SKILL.md 2,356 B
  • docs SUMMARY.md 300 B

History

  1. First seen on skills.sh
  2. First recorded snapshot · 2 installs

SKILL.md

Навичка: Архітектор Документації

Використовуй цю навичку для генерації або оновлення файлу README.md.

Обов'язкові розділи документації

  1. Назва та Слоган: Чітка назва та опис (наприклад, "Modern Vanilla JS Template 2026").
  2. Технологічний стек: Перелік ключових інструментів (Vite 7, ESLint Flat Config, Vitest, Axe-core).
  3. Особливості (Features):

- Multi-Page Application (MPA) архітектура. - Оптимізація зображень (Sharp/SVGO) та шрифтів (Variable fonts) "з коробки". - Accessibility-first підхід (WCAG 2.2 Level AA). - AI-Friendly інфраструктура (папка .github/skills).

  1. Швидкий старт: Команди npm install, npm run dev, npm run build.
  2. Структура проекту: Коротке пояснення папок (src/, public/, styles/, та інших директорій проекту).
  3. Якість коду та Тестування: Пояснення ролі лінтерів та тестів на доступність.
  4. AI Agents Usage: Як використовувати вбудовані ролі (@Builder, @Auditor) у VS Code Copilot.

Тон та Стиль (Tone of Voice)

  • Професійний, технічний, але лаконічний.
  • Використання Emoji для візуального розділення секцій.
  • Чіткі блоки коду з підсвіткою синтаксису.
  • Відповідність WCAG навіть у документації (логічна ієрархія заголовків).

Приклад структури файлів

Завжди вказуй дерево проекту для швидкої орієнтації.