Как вести документацию - Wraithbound Engineering

Документация является частью изменения. Если меняется контракт, deployment, путь, переменная окружения или операторский сценарий, связанная страница должна обновляться в том же pull request.

Где писать

Изменение	Раздел
Пользовательский или main-process сценарий Electron	`launcher/`
API, БД, admin UI или интеграция сайта	`site/`
Rust crate, протокол или native binary	`native/`
Выпуск, диагностика и сквозные процедуры	`operations/`
Proxmox, сеть, сервисы и аварийные действия	`infrastructure/`

Если информация относится к двум компонентам, основная инструкция хранится рядом с владельцем процесса, а со второй страницы ставится ссылка. Не копируйте один и тот же длинный runbook в разные разделы.

Шаблон страницы

---
title: "Короткое название"
description: "Какую задачу решает страница"
icon: "lucide-icon"
---

Одним абзацем: для кого страница и какой результат она даёт.

## Перед началом

Требования, доступы и безопасные ограничения.

## Порядок действий

<Steps>
  <Step title="Первое действие">Проверяемый результат.</Step>
  <Step title="Второе действие">Проверяемый результат.</Step>
</Steps>

## Проверка

Команды и наблюдаемые признаки успеха.

## Откат

Как вернуться в исходное состояние.

Требования к содержанию

Пишите результат и критерий проверки, а не историю разработки.
Используйте точные команды, но не вставляйте реальные токены и пароли.
Указывайте владельца данных: Git, Proxmox, systemd, S3 или база.
Для опасной операции всегда описывайте backup и rollback.
Отмечайте предположения словом «не подтверждено».
Не публикуйте скриншоты с cookies, ключами, IPMI и recovery-кодами.
Не храните две таблицы с одним инвентарём: ставьте ссылку на каноническую.

Проверка перед коммитом

cd E:\Wraithbound\wraithbound-launcher-platform\docs
npm run validate

Проверьте также, что новая страница добавлена в docs.json, внутренние ссылки открываются, а примеры используют placeholder вместо секрета.

Даже приватная wiki не является password manager. Секрет хранится в secret store; документация объясняет, как он называется, кем используется и как ротируется.