AgentSkillsCN

readme-gen

为基于Vanilla Vite多页面应用的项目编写高层级文档，专注于技术准确性、可访问性以及开发人员的使用便利性。

SKILL.md
--- frontmatter
name: readme-gen
description: Створення високорівневої документації для проектів на базі Vanilla Vite Multi-Page App. Сфокусовано на технічній точності, доступності та зручності для розробників.
version: 1.0.0

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

Використовуй цю навичку для генерації або оновлення файлу 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).
  4. •Швидкий старт: Команди npm install, npm run dev, npm run build.
  5. •Структура проекту: Коротке пояснення папок (src/, public/, styles/, та інших директорій проекту).
  6. •Якість коду та Тестування: Пояснення ролі лінтерів та тестів на доступність.
  7. •AI Agents Usage: Як використовувати вбудовані ролі (@Builder, @Auditor) у VS Code Copilot.

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

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

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

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