Aleksey Shakhmatov
c068dfae0c
- permission-gate: block refs/tags/v* pushes, rm -r -f separated flags, git reset --hard, git clean (verified against actual bypasses) - prompts: /bugfix /feature /review no longer hardcode go-standards — reference profile-gated <lang>-standards instead - company-context: drop hardcoded Go stack, note TRACKER_URL priority, warn on context truncation instead of silently dropping rules - repo-map/docs-map: graceful degradation when config values are TODO - /kit-doctor: warn on unfilled config fields (repoMap/trackerUrl/docsUrl) - audit: retry POSTs to endpoint (3 attempts, backoff), still best-effort - install.sh: remove TODO course URL from cheat sheet - tests: expand guardrails (43 node checks), add shell tests for create-mr.sh (scp/https origin parse, GITLAB_HOST override, protected branch refusal), cover company-context lib (normalize/fetch/truncation) and mcp-bridge - commit package-lock.json for reproducible installs - document npm test Node >= 22.6 requirement (type stripping)
43 lines
2.8 KiB
Markdown
43 lines
2.8 KiB
Markdown
---
|
|
name: docs-map
|
|
description: Используй, когда нужно найти или написать внутреннюю документацию — где искать по теме, какие есть ключевые пространства/разделы, куда класть новую страницу или RFC. Применяй при вопросах «где документация», «куда записать», «есть ли дока по», а также в команде /rfc.
|
|
---
|
|
|
|
# Работа с документацией
|
|
|
|
Скилл помогает искать существующую документацию и правильно размещать новую.
|
|
|
|
## Адрес документации
|
|
|
|
Адрес портала документации — в поле `docsUrl` корпоративного конфига. Его текущее значение
|
|
инжектится в **корпоративный контекст сессии** расширением `company-context` — бери адрес
|
|
оттуда, здесь он намеренно не дублируется (единый источник правды — `config/company.json`).
|
|
|
|
## Ключевые пространства/разделы
|
|
|
|
<!-- TODO: заполнить реальными значениями компании -->
|
|
|
|
- **Архитектура и RFC:** `<!-- TODO: пространство/раздел -->`
|
|
- **Гайды по сервисам:** `<!-- TODO -->`
|
|
- **Онбординг:** `<!-- TODO -->`
|
|
- **Runbooks / эксплуатация:** `<!-- TODO -->`
|
|
|
|
## Как искать
|
|
|
|
1. Начни с портала документации (адрес — из корпоративного контекста сессии).
|
|
2. `<!-- TODO: описать, где встроенный поиск, теги/лейблы, как называть страницы -->`
|
|
|
|
### Если разделы ещё не заполнены (TODO)
|
|
|
|
Пока в скилле и конфиге стоят TODO/пустые значения — **не выдумывай структуру документации**.
|
|
Скажи пользователю, что карта документации не заполнена, и спроси, где искать или куда
|
|
писать; можно предложить уточнить у владельца документации.
|
|
|
|
## Куда писать новое
|
|
|
|
<!-- TODO: заполнить -->
|
|
|
|
- Новую страницу по фиче: `<!-- TODO: в какое пространство/раздел -->`
|
|
- RFC/ADR: `<!-- TODO: где живут, шаблон -->`
|
|
- Правило: не дублируй информацию — сначала поищи существующую страницу и обнови её.
|