Files
claude-howto/uk/01-slash-commands/doc-refactor.md
T
Luong NGUYEN b9a973bf32 docs: accuracy pass against Claude Code v2.1.220 (#155)
Internal accuracy pass against v2.1.220 — no missing upstream features, but broken example code, disagreeing counts, and metadata drift.

Functional fixes: pre-commit.sh now exits 2 so it actually blocks; dependency-check.sh reads file_path from stdin JSON instead of $1; database-mcp.json uses ${DATABASE_URL}; broken fences repaired; three command templates had invalid skill names.

Factual corrections: /fork and /subtask unswapped and /subtask added; /fewer-permission-prompts; permissions.defaultMode; dontAsk/auto unreversed; 31 hook events verified name-by-name; subagent depth 3; skill precedence enterprise > project > personal; /output-style removed not deprecated; permissionDecision gained defer.

Follow-up review fixed defects the pass left behind: zh/vi headers claiming 31 events above 25-name lists, a surviving hardcoded DB credential in the MCP README examples, an unbalanced fence swallowing a metadata footer, and non-canonical tool names. All four translated CATALOG summary tables were recounted so their arithmetic holds.

Full detail in CHANGELOG.md under v2.1.220-r2.
2026-08-04 15:41:12 +07:00

2.4 KiB

name, description
name description
doc-refactor Реструктуризація документації проєкту для ясності та доступності

Рефакторинг документації

Рефакторинг структури документації проєкту з адаптацією до типу проєкту:

  1. Аналіз проєкту: Визначити тип (бібліотека/API/веб-додаток/CLI/мікросервіси), архітектуру та персони користувачів
  2. Централізація документації: Перемістити технічну документацію до docs/ з належними перехресними посиланнями
  3. Кореневий README.md: Оптимізувати як точку входу з оглядом, швидким стартом, резюме модулів/компонентів, ліцензією, контактами
  4. Документація компонентів: Додати README файли на рівні модулів/пакетів/сервісів з інструкціями налаштування та тестування
  5. Організація docs/ за відповідними категоріями:
    • Архітектура, Довідник API, База даних, Дизайн, Усунення несправностей, Деплой, Контрибʼюція (адаптувати до потреб проєкту)
  6. Створення посібників (оберіть застосовні):
    • Посібник користувача: Документація для кінцевих користувачів додатків
    • Документація API: Ендпоінти, автентифікація, приклади для API
    • Посібник розробника: Налаштування, тестування, процес контрибʼюції
    • Посібник деплою: Деплой на продакшн для сервісів/додатків
  7. Використання Mermaid для всіх діаграм (архітектура, потоки, схеми)

Тримайте документацію лаконічною, зручною для сканування та контекстно відповідною типу проєкту.


Останнє оновлення: 9 квітня 2026