Skip to main content

Document standard

.pipeline/docs/DOCUMENT-STANDARD.md (canonical copy in the kit under kit/pipeline/docs/) defines how to author pack files so they stay portable.

Document types

TypePathWhat a new project changes
Agent briefagents/*.mdAlmost never
Skillskills/*/SKILL.mdCommands/paths only in deploy and test skills
Templateskills/*/assets/*-template.mdPlaceholders only
Policy*-policy.mdTrue/false columns
Wikiwiki/*.mdAdd a page after retro
Rulerules/*.mdcNarrow globs to this repo
Handbookdocs/*.md, pack README.mdPer engagement: project AGENTS.md and config.json

Required header

Every brief, skill, policy, wiki page, rule, and handbook starts with Type / Audience / Adapt.

Section order

  • Agent brief: Role → Isolation → Inputs → Procedure → Outputs → Failure → Parent next
  • Skill: Purpose → When to use / not → Adapt → Procedure → Failure → Anti-patterns
  • Wiki: Symptom → Root cause → Do not → Convention → Files → Verify

Forbidden in the pack

Application folder names, sample shop names, internal platform names, demo localhost ports, and issue keys from a past engagement. Those belong in the project overlay (config.json, AGENTS.md, deploy/test skills).

Secrets never appear in pack markdown.