Skip to main content

documentation

Route documentation/notes to the right destination (Confluence, README/CLAUDE.md, Obsidian, or NetBox) based on content type, and confirm the exact destination with the user before writing anything. Also invoke proactively — before opening a PR — when the change is a new operational gotcha, an incident, a security-hardening trade-off, a version-pin rationale, a new app/cluster, or a structural Terraform/infra change, to decide whether README.md, a CLAUDE.md, or Confluence needs updating.

Ir para a instalação

Informações da origem

Repositório
dark-vex/infra-cd
Última atividade na origem
12 de julho de 2026 às 16:03
Idioma detectado do SKILL.md
inglês
Estrelas
8
Forks
0

Opções de instalação

Por padrão, está selecionado o prompt que primeiro revisa a origem. Você pode mudar para um comando direto ou baixar uma cópia local.

Revise os arquivos de origem

Leia o SKILL.md e os arquivos complementares exibidos pelo SkillsMP antes de decidir se vai instalar.

Exibindo SKILL.md

SKILL.md
Instruções da origem · Visualização somente leitura
name
documentation
description
Route documentation/notes to the right destination (Confluence, README/CLAUDE.md, Obsidian, or NetBox) based on content type, and confirm the exact destination with the user before writing anything. Also invoke proactively — before opening a PR — when the change is a new operational gotcha, an incident, a security-hardening trade-off, a version-pin rationale, a new app/cluster, or a structural Terraform/infra change, to decide whether README.md, a CLAUDE.md, or Confluence needs updating.
# Documentation Routing Skill Use this skill whenever asked to write down, document, save, or note something — before picking a destination, classify the content and confirm the exact target with the user. Never guess a destination and write silently; getting this wrong scatters knowledge across the wrong tool and is hard to undo. ## Routing table | Content type | Destination | Mechanism | |---|---|---| | Runbooks, architecture decisions, postmortems | Confluence | `createConfluencePage` / `updateConfluencePage`. If the target space is ambiguous, ask which space before writing. | | Repo usage, conventions, how-to guides | README.md / directory-level READMEs / CLAUDE.md | Direct file edit + PR, following this repo's normal git workflow (feature branch, semantic commit, never push to `main`). | | Personal notes, ideas, journal entries | Obsidian | `obsidian_append_content` or an appropriate periodic note. | | Infra inventory (hosts, IPs, VM/device records) | NetBox | Verify current state via the NetBox MCP tools first (**read-only** in this workflow) — writes never go through the MCP directly. Instead, author/update `terraform/netbox/*.tf` and open a PR, so NetBox state stays under GitOps/Terraform control like everything else in this repo. | ## When to proactively invoke Don't wait to be asked. Before opening a PR, check whether the change falls into one of these categories, and if so, run through this skill's routing table rather than merging silently: - A new operational gotcha (a chart quirk, a workaround, a non-obvious ordering requirement) - An incident or its postmortem - A security-hardening trade-off (why a control was loosened/tightened, what was accepted as risk) - A version-pin rationale (why a dependency is pinned below latest, or pinned to a specific SHA) - A new app or cluster - A structural Terraform/infra change (new module, new environment, moved state backend, changed CI topology) This list is intentionally narrow — it mirrors the categories already migrated out of YAML comments in PR #1638. Routine dependency bumps, one-line fixes, and other day-to-day changes don't need this check; treating "after any change" as the trigger would reintroduce the noise problem a hook would have caused. ## Mixed content If a request spans more than one row (e.g. "document this incident and also note it needs a NetBox entry for the new host"), split it and route each piece separately — don't force multi-type content into one destination. ## Before writing: confirm the destination State the exact target before making any change, and wait for confirmation if there's any ambiguity: - Confluence: which space and page (existing page to update vs. new page + where it should live in the page tree) - Obsidian: which vault path / note - File edit: which exact file path - NetBox: which Terraform resource in `terraform/netbox/` (new resource vs. editing an existing one) Skip the confirmation only when the user has already stated the exact destination unambiguously in their request. ## Out of scope This skill does not cover code comments or inline documentation as part of a normal code change — that's ordinary development, not a "write documentation" request.
Ver no GitHub