Files
medassist-ng/.github/skills/medassist-doc-sync-guard/SKILL.md
T

1.1 KiB

name, description
name description
medassist-doc-sync-guard Ensure MedAssist documentation stays aligned with behavior changes in APIs, configuration, setup, and operations, including equivalent requests phrased in German.

Skill Instructions

Use this skill when code changes alter behavior, setup steps, environment variables, user workflows, or operational commands.

Objective

Keep docs consistent with actual product behavior and avoid stale setup/run guidance.

Required Checks

  1. If API behavior changed, verify relevant docs are updated.
  2. If ENV/config changed, update documented variables/defaults.
  3. If workflow/commands changed, update setup/run instructions.
  4. If user-facing behavior changed, update user-facing description.

Candidate Documentation Files

  • README.md
  • docs/PROJECT_SETUP.md
  • docs/TECH_STACK.md

Anti-Patterns

  • Shipping behavior changes without docs updates.
  • Updating docs with speculative/unverified commands.
  • Duplicating conflicting instructions across files.

Response Format

Return:

  • Doc files that should change
  • Proposed update summary per file
  • Any intentionally skipped docs and reason