3 Wiki Structure And Rules
Roman edited this page 2026-07-01 22:16:45 +03:00
This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

Структура и правила Wiki

Цель Wiki

Wiki нужна как рабочая база знаний. Она должна отвечать на вопросы:

  • что за объект;
  • где он лежит в Unity/server/catalog files;
  • что уже готово;
  • чего не хватает;
  • какие задачи связаны с объектом;
  • как проверить готовность;
  • почему объект отложен, выключен или исключен.

Базовая структура

Wiki/
  Home
  Project/
    Overview
    Scope
    PlanningRules
  Architecture/
    SystemArchitecture
    DataSources
  UnityClient/
    Scenes
    PreviewBuild
    RuntimePatterns
  ServerNetwork/
    LoginServer
    GameServer
    Packets
  Characters/
    ReferencePrefabPattern
    VisualArchetypes
    ClassIds
  Maps/
    Cells
    Collision
    Geodata
    Streaming
  NPC/
    Catalog
    RuntimeMonsters
    RuntimeNPCs
    Services
  Items/
    Catalog
    Categories
    Equipment
  Skills/
    Catalog
    Runtime
    Effects
    Icons
  UI/
    Screens
    Widgets
  QA/
    Smoke
    Regression
    Release

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

Каждая объектная страница должна иметь одинаковые секции:

# Object Name

## Summary

Коротко: что это за объект и зачем он нужен.

## Source Files

| Type | Path / ID | Comment |
| --- | --- | --- |

## Текущее состояние

Что уже найдено в проекте.

## Чего не хватает / блокеры

Что не готово конкретно: prefab, animator, collider, packet, UI state, icon, VFX, DB row, data mapping.

## Целевое состояние

Что должно быть, чтобы объект считался production-ready.

## Чек-лист реализации

- [ ] Конкретный пункт

## Проверка

Как проверить готовность: Play Mode, build smoke, server/client logs, screenshot, profiler, packet trace.

## Связанные задачи

Ссылки на GitWork issues и blockers.

## История статуса

Дата, статус, кто обновил, что изменилось.

Правила обновления

  • Issue нельзя закрывать без обновления связанной Wiki-страницы.
  • Если объект исключается, причина фиксируется в Wiki.
  • Если объект переносится на later scope, причина фиксируется в Wiki.
  • Если агент нашел новый blocker, он добавляет его в Wiki и создает linked issue.
  • Если данные неизвестны, писать needs-triage и конкретный источник, который надо проверить.

Что не писать

Не использовать формулировки:

  • и т.д.;
  • проверить все;
  • доделать UI;
  • настроить NPC;
  • починить карту.

Вместо этого писать конкретно:

  • проверить collider/click area/nameplate/dialog binding для prefab X;
  • добавить empty/loading/error states для Inventory UI;
  • сопоставить NPC id 12345 с server template и Unity visual;
  • проверить scene 16_10: terrain colliders, static mesh colliders, water, spawn alignment.