qmu/write-terms

Write Terms

Guidelines for writing and updating terminology documentation in .workaholic/terms/.

Gather Context

Run the bundled script to collect information about what changed:

bash ${CLAUDE_PLUGIN_ROOT}/skills/write-terms/scripts/gather.sh [base-branch]

Default base branch is main.

Output Sections

The script outputs structured information:

=== BRANCH ===
<current branch name>

=== TICKETS ===
<list of archived tickets for this branch, or "No archived tickets">

=== TERMS ===
<list of existing term files>

=== DIFF ===
<git diff stat against base branch>

=== COMMIT ===
<current short commit hash>

Using the Output

• BRANCH: Use to locate archived tickets
• TICKETS: Read these to understand what changed and what new terms may exist
• TERMS: Survey these to find documents needing updates
• DIFF: Use when no tickets exist to understand changes
• COMMIT: Use in frontmatter commit_hash field

Term Categories

| File | Terms | | --------------------- | ---------------------------------------- | | core-concepts.md | plugin, command, skill, rule, agent | | artifacts.md | ticket, spec, story, changelog | | workflow-terms.md | drive, archive, sync, release | | file-conventions.md | kebab-case, frontmatter, icebox, archive | | inconsistencies.md | Known terminology issues |

Term Entry Format

Each term is a single comprehensive paragraph that incorporates definition, usage context, examples, and related concepts:

## term-name

A comprehensive paragraph describing what this term means in the Workaholic context, how it's used (directory names, file names, code references), its relationship to other terms, and any known inconsistencies. The paragraph should be self-contained and readable, providing all necessary context for understanding the term.

Keep paragraphs focused but complete - typically 3-8 sentences covering the essential information.

Frontmatter

Required for every terms file:

---
title: Document Title
description: Brief description of this document
category: developer
last_updated: YYYY-MM-DD
commit_hash: <short-hash>
---

Use the commit hash from the COMMIT section of the context output.

Index File Updates

When adding a term:

• Add to the appropriate category file
• If it's a major new concept, consider adding to README

When deprecating a term:

• Mark as deprecated in the definition
• Note what replaced it
• Keep for historical reference

Critical Rules

• Consistency over precision - A term should mean the same thing everywhere
• Every ticket may introduce terms - Even small changes may use new terminology
• Only delete within .workaholic/ - Safety constraint for file deletions
• Update last_updated - Set to current date when modifying any doc
• Update commit_hash - Use value from context COMMIT section