ckb/templates
Michał Kopeć bbfda5a65d Sync: local changes as of 2026-10-29T13:50:12Z
Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
2026-10-29 14:50:12 +01:00
..
README.md Sync: local changes as of 2026-10-29T13:50:12Z 2026-10-29 14:50:12 +01:00
status-report.md Sync: local changes as of 2026-10-29T13:50:12Z 2026-10-29 14:50:12 +01:00

Document templates

A document template is a Markdown file that lays out a document's sections and tells the agent what each section should hold. Say "prepare a new document using template status-report" and the agent reads the template, follows its hints, asks you where a hint says to ask, pulls from the wiki where a hint names a source, and writes the finished document to outputs/documents/.

These are your files. The agent never edits a template on its own; it only writes a new one when you ask for it ("make a template for a handover note"). ckb-reset leaves this folder alone and ckb-upgrade never overwrites it.

Format

---
type: template
tldr: One line saying what kind of document this produces.
output: outputs/documents/{{date}}-handover-{{slug}}.md
---

# Handover: {{subject}}

<!-- Ask the user what is being handed over and to whom. -->

## Current state

<!-- Source: the wiki page for {{subject}}. Three to five sentences, no history. -->

## Open items

<!-- Copy the open items from that page. If there are none, write "None". -->

*Prepared from the knowledge base on {{date}}.*

The rules the agent follows:

  • Every <!-- comment --> is an instruction, not text. It is read, acted on and dropped from the finished document. Write it the way you would brief a colleague: what goes in the section, where to find it, how long it should be, and whether to ask you first.
  • Everything outside a comment is copied as written: headings, boilerplate, signatures, legal lines.
  • {{date}}, {{author}} and {{slug}} are filled in by the agent (today, the git identity, a short slug of the document's subject). Any other {{name}} is asked for once, unless a comment says where it comes from.
  • output: is optional. Without it the document lands in outputs/documents/ under the template's name, today's date and the slug.
  • A hint that names a source the agent cannot find, or a question you don't answer, becomes a one-line TODO: in the document rather than invented text.

The example in this folder, status-report.md, uses every one of these. Copy it to start your own. Only files with type: template in their frontmatter count as templates; this README does not.