Term document structure, formatting rules, and guidelines for updating .workaholic/terms/.
From standardsnpx claudepluginhub qmu/workaholic --plugin standardsThis skill is limited to using the following tools:
sh/gather.shGuidelines for writing and updating terminology documentation in .workaholic/terms/.
Run the bundled script to collect information about what changed:
bash ${CLAUDE_PLUGIN_ROOT}/skills/write-terms/sh/gather.sh [base-branch]
Default base branch is main.
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>
commit_hash field| 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 |
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.
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.
When adding a term:
When deprecating a term:
i18n mirroring:
When terminology files have translations (e.g., artifacts.md and artifacts_ja.md):
translate skill for translation requirements.workaholic/ - Safety constraint for file deletionslast_updated - Set to current date when modifying any doccommit_hash - Use value from context COMMIT section_ja.md exists, update both files