Document type: function

Table of Contents

This page defines the function document type — one entry in the document types taxonomy. The general contract every document follows (frontmatter, state, linking, tags) lives on the taxonomy page; this page carries only what is specific to function.

Contract

A function is role-shaped: it describes a named role and lists the operational skills, recipes, and pre-reads that role uses. Think of it as the priming context an LLM session loads when it takes on that role — "you are S2 orchestrator, here is what you do, here is what you do not do, here are the skills available to you." Compare with skill below, which is task-shaped.

Folder
doc/functions/
Level
cross or a specific level.
How to create
function codegen is not yet wired into generate_doc.sh (no --type function yet); for now, copy an existing function under doc/functions/ and adjust the frontmatter and sections.
(no term)
Not stateful — no TODO.
Required sections
  • * Purpose — one paragraph: what this role is for.
  • * Operates at — which system level(s); link to cybernetic levels.
  • * Inputs — what this role consumes (documents, signals).
  • * Outputs — what this role produces.
  • * Pre-reads — documents that must be loaded into context before the role can act. The contract docs go here.
  • * Skills — id-links to the skills this role invokes.
  • * Recipes — id-links to the recipes this role exercises.
  • * Boundaries — what this role explicitly does not do, and which other function picks it up instead.

Emacs 29.1 (Org mode 9.6.6)