dev
0725b6b034
- descriptions state WHEN each skill applies - jira-workflow ships curl scripts reading TRACKER_URL/JIRA_TOKEN from env, no hardcoded secrets/URLs - repo-map/docs-map defer values to session corporate context; company specifics left as TODO - go-standards uses realistic Go defaults, company-specific bits marked TODO
37 lines
2.3 KiB
Markdown
37 lines
2.3 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: в какое пространство/раздел -->`
|
|
- RFC/ADR: `<!-- TODO: где живут, шаблон -->`
|
|
- Правило: не дублируй информацию — сначала поищи существующую страницу и обнови её.
|