Skip to main content

Wiki Maintenance Policy

This repository treats the wiki as an engineering artifact, not optional after-the-fact documentation.

Default rule​

When a system flow changes in the app, the corresponding wiki page must be updated in the same task by default.

Examples:

  • login or session behavior changes
  • branch selection logic changes
  • home navigation or menu gating changes
  • sales, payment, printer, scanner, or customer-display flows change
  • Android setup or release steps change

Expected behavior for future work​

  • If code changes alter user-visible flow, update the matching workflow page in docs-site/docs/.
  • If architecture boundaries or responsibilities change, update the matching architecture page.
  • If machine setup or release steps change, update the matching setup page.
  • If the change is documentation-relevant over time, add an entry to governance/change-log.
  • If the change is small but still useful as project history, prefer adding a short changelog entry instead of omitting it.
  • If no suitable page exists yet, create one instead of leaving the change undocumented.

Practical rule for this project​

For mobile and terminal work, documentation updates should be considered part of the definition of done when the task changes:

  • screen sequence
  • decision points
  • required setup steps
  • permission gates
  • external device interactions

Why this exists​

This project has multiple apps, role-based menus, branch-dependent behavior, and device-specific flows. If the wiki is not updated alongside flow changes, the documentation becomes misleading quickly.