Files
filemaker-ai-core/docs/project-contract.md
T

1.9 KiB

Project Contract

Every client AI workspace owns its client context. Keep the project root small, explicit, and safe to open directly in VS Code.

Instruction layout

  • Root AGENTS.md: a short, mandatory router. It tells an agent to read the local PROJECT.md and this Core AGENTS.md before work.
  • PROJECT.md: only client and project facts, organization-specific standards, and true project-specific exceptions.
  • Core AGENTS.md: shared evidence priority, repository map, workflow, and response rules.
  • Core skills: task-specific procedures read only when relevant.

Do not use a filesystem symlink for PROJECT.md; track it directly in the client repository.

Project-owned material

  • client name and project scope
  • confirmed business rules and decisions
  • tickets, project notes, and approved analysis
  • sanitized parsed DDR
  • FileMaker work scripts and project-specific prompts
  • project-specific raw DDR environments or any deviation from the standard repository map

Standard workspace map

  • TICKETS/: one folder per ticket or workstream, including its source requests, handoffs, analysis, questions, reports, assets, and ticket-specific scripts.
  • FMSCRIPTS/: tracked complete .fmscript files that are not clearly ticket-specific or apply across workstreams.
  • NOTES/: confirmed knowledge that applies across more than one ticket.
  • DDR-Parsed/: tracked generated reference material; do not edit it manually.
  • sibling DDR/: local raw DDR input; never commit it.

Core-owned material

  • generic FileMaker analysis and scripting workflow
  • reusable prompts and templates
  • generic DDR handling and secret-safety guidance
  • client-neutral helper scripts

Instruction precedence

When guidance conflicts, preserve project evidence and confirmed client decisions. A project may opt into an additional organization-specific standard without applying it to other clients.