aboutsummaryrefslogtreecommitdiff
path: root/.ai/workflows/create-workflow.org
diff options
context:
space:
mode:
Diffstat (limited to '.ai/workflows/create-workflow.org')
-rw-r--r--.ai/workflows/create-workflow.org8
1 files changed, 8 insertions, 0 deletions
diff --git a/.ai/workflows/create-workflow.org b/.ai/workflows/create-workflow.org
index e6587c8..6060df1 100644
--- a/.ai/workflows/create-workflow.org
+++ b/.ai/workflows/create-workflow.org
@@ -223,6 +223,14 @@ Write the workflow file at =.ai/workflows/[name].org= using this structure:
- Include decision frameworks for common situations
- Note that this is a living document
+*** Supporting documents
+
+When a workflow needs more supporting content than fits inline (a condensed method that has a fuller reference version, an extracted procedure, a long reference table), store it in a sibling file named after the workflow with a descriptive suffix — =<workflow>.<suffix>.org= — and link it inline as part of the sentence, not as a bare "see X" footnote.
+
+This reuses the dot-delimited =engine.plugin.org= convention: the startup =.ai/= rsync, the INDEX.org drift-check, and the workflow-discovery glob already recognize a dotted name =foo.bar.org= as belonging to =foo=, so a supporting doc is correctly *not* treated as an independently-triggerable workflow or an INDEX orphan. It also keeps the workflow promotion-safe — when a project-only workflow is promoted to a template, its supporting files travel with it under the same prefix, whereas a link into a project-specific =assets/= doc would break on promotion.
+
+Worked example: a meeting-prep workflow whose mid-flow phase carries a condensed version of a method, with the full method extracted to =meeting-prep.pre-wire.org= beside it and linked inline.
+
** Phase 5: Update Project State
Update =notes.org=: