Beads Documentation Style Guide
gastownhall/beads
Sets the house style for the beads user docs: the canonical concept model, required terminology, prose and diagram conventions, and checks before docs work is done.
Fills in empty embedded help text for TiXL's UI topics by distilling the maintainer's own video explanations into short, user-facing doc entries.
Install TiXL UI Topic Doc Writer
$ npx skills add tixl3d/tixl --skill write-topic-docs -a claude-codeProject install by default; add -g for ~/.claude/skills/.
$ gh skill install tixl3d/tixl write-topic-docs --agent claude-codeProject scope by default; add --scope user for a personal install. Needs GitHub CLI 2.90.0 or later (public preview).
$ git clone --depth 1 https://github.com/tixl3d/tixl.git skills-src && mkdir -p .claude/skills && cp -r skills-src/.claude/skills/write-topic-docs .claude/skills/write-topic-docs && rm -rf skills-srcUse ~/.claude/skills/ instead of .claude/skills for a personal install. The folder must contain SKILL.md.
Claude Code skills documentation · loads skills from .claude/skills/
Install the "write-topic-docs" agent skill from https://github.com/tixl3d/tixl/tree/main/.claude/skills/write-topic-docs into .claude/skills/write-topic-docs/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "write-topic-docs", then confirm the skill loads.Claude Code copies the folder itself, the same result as the manual copy. Check what it changed before you commit it.
$skill-installer install https://github.com/tixl3d/tixl/tree/main/.claude/skills/write-topic-docsType this inside Codex. $skill-installer <name> installs a curated skill from openai/skills. The installer writes to $CODEX_HOME/skills (default ~/.codex/skills). Restart Codex if the skill does not show up.
$ npx skills add tixl3d/tixl --skill write-topic-docs -a codexProject install goes to .agents/skills/; add -g for ~/.codex/skills/.
$ gh skill install tixl3d/tixl write-topic-docs --agent codexProject scope by default (.agents/skills/); add --scope user for a personal install.
$ git clone --depth 1 https://github.com/tixl3d/tixl.git skills-src && mkdir -p .agents/skills && cp -r skills-src/.claude/skills/write-topic-docs .agents/skills/write-topic-docs && rm -rf skills-srcUse ~/.agents/skills/ instead of .agents/skills for a personal install.
Codex skills documentation · loads skills from .agents/skills/
Install the "write-topic-docs" agent skill from https://github.com/tixl3d/tixl/tree/main/.claude/skills/write-topic-docs into .agents/skills/write-topic-docs/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "write-topic-docs", then confirm the skill loads.Codex copies the folder itself, the same result as the manual copy. Check what it changed before you commit it.
$ npx skills add tixl3d/tixl --skill write-topic-docs -a cursorProject install goes to .agents/skills/; add -g for ~/.cursor/skills/.
$ gh skill install tixl3d/tixl write-topic-docs --agent cursorProject scope by default (.agents/skills/); add --scope user for a personal install.
$ git clone --depth 1 https://github.com/tixl3d/tixl.git skills-src && mkdir -p .cursor/skills && cp -r skills-src/.claude/skills/write-topic-docs .cursor/skills/write-topic-docs && rm -rf skills-srcUse ~/.cursor/skills/ instead of .cursor/skills for a personal install.
Cursor skills documentation · loads skills from .cursor/skills/, .agents/skills/, .claude/skills/, .codex/skills/
Install the "write-topic-docs" agent skill from https://github.com/tixl3d/tixl/tree/main/.claude/skills/write-topic-docs into .cursor/skills/write-topic-docs/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "write-topic-docs", then confirm the skill loads.Cursor copies the folder itself, the same result as the manual copy. Check what it changed before you commit it.
$ gemini skills install https://github.com/tixl3d/tixl.git --path .claude/skills/write-topic-docs--scope user (default) or --scope workspace; --path is the subfolder of the repo that holds the skill; --consent skips the security confirmation prompt.
$ npx skills add tixl3d/tixl --skill write-topic-docs -a gemini-cliProject install goes to .agents/skills/; add -g for ~/.gemini/skills/.
$ gh skill install tixl3d/tixl write-topic-docs --agent gemini-cliProject scope by default (.agents/skills/); add --scope user for a personal install.
$ git clone --depth 1 https://github.com/tixl3d/tixl.git skills-src && mkdir -p .gemini/skills && cp -r skills-src/.claude/skills/write-topic-docs .gemini/skills/write-topic-docs && rm -rf skills-srcUse ~/.gemini/skills/ instead of .gemini/skills for a personal install, then run /skills reload.
Gemini CLI skills documentation · loads skills from .gemini/skills/, .agents/skills/
Install the "write-topic-docs" agent skill from https://github.com/tixl3d/tixl/tree/main/.claude/skills/write-topic-docs into .gemini/skills/write-topic-docs/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "write-topic-docs", then confirm the skill loads.Gemini CLI copies the folder itself, the same result as the manual copy. Check what it changed before you commit it.
$ gh skill install tixl3d/tixl write-topic-docsInstalls for Copilot at project scope by default; add --scope user for a personal install. Preview a skill first with gh skill preview. Needs GitHub CLI 2.90.0 or later (public preview).
$ npx skills add tixl3d/tixl --skill write-topic-docs -a github-copilotProject install goes to .agents/skills/; add -g for ~/.copilot/skills/.
$ git clone --depth 1 https://github.com/tixl3d/tixl.git skills-src && mkdir -p .github/skills && cp -r skills-src/.claude/skills/write-topic-docs .github/skills/write-topic-docs && rm -rf skills-srcUse ~/.copilot/skills/ instead of .github/skills for a personal install. Commit .github/skills so cloud agent and code review can use it.
GitHub Copilot skills documentation · loads skills from .github/skills/, .claude/skills/, .agents/skills/
Install the "write-topic-docs" agent skill from https://github.com/tixl3d/tixl/tree/main/.claude/skills/write-topic-docs into .github/skills/write-topic-docs/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "write-topic-docs", then confirm the skill loads.GitHub Copilot copies the folder itself, the same result as the manual copy. Check what it changed before you commit it.
$ npx skills add tixl3d/tixl --skill write-topic-docs -a opencodeOpenCode documents no install command of its own. Project install goes to .agents/skills/; add -g for ~/.config/opencode/skills/.
$ gh skill install tixl3d/tixl write-topic-docs --agent opencodeProject scope by default (.agents/skills/); add --scope user for a personal install.
$ git clone --depth 1 https://github.com/tixl3d/tixl.git skills-src && mkdir -p .opencode/skills && cp -r skills-src/.claude/skills/write-topic-docs .opencode/skills/write-topic-docs && rm -rf skills-srcUse ~/.config/opencode/skills/ instead of .opencode/skills for a personal install.
OpenCode skills documentation · loads skills from .opencode/skills/, .claude/skills/, .agents/skills/
Install the "write-topic-docs" agent skill from https://github.com/tixl3d/tixl/tree/main/.claude/skills/write-topic-docs into .opencode/skills/write-topic-docs/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "write-topic-docs", then confirm the skill loads.OpenCode copies the folder itself, the same result as the manual copy. Check what it changed before you commit it.
Facts
- Skill name
write-topic-docs- GitHub stars
- 5.1k
- Token cost
- ~952 tokens
- SKILL.md length
- 484 words
- Files
- 1
- Skills in repo
- 5
- Repo updated
- First seen
- Licence
- MIT
At a glance
Fills in empty embedded help text for TiXL's UI topics by distilling the maintainer's own video explanations into short, user-facing doc entries.
- Works in 4 steps: find the work → read the source bundle (per topic) → draft (per topic) → …
- Filling in a UI topic's empty help-panel doc after videos have been transcribed
- SKILL.md covers Hard invariants, Step 1 — find the work, Step 2 — read the source… and Step 3 — draft (per topic), plus 2 more sections
- Calls python and git
What it does
Is the fourth stage of a documentation pipeline, running only after an earlier video-transcription stage has populated a mentions file with topic references. For each topic still missing a doc body, a bundled Python script lists its source bundle: the implementing class, any existing help page, and the top transcript passages discussing it, ranked from in-depth to merely mentioned and sorted by recency.
A drafted entry is one stand-alone sentence saying what the feature is and when to reach for it, followed by two to four sentences on where to find it, its key actions, and one practical tip, written in second person with UI elements bolded on first mention and operators placed in brackets so the docs build can auto-link them. The implementing class is read only to verify behavior for the fact-check, never named in the prose itself, keeping implementation detail out of the user-facing help.
Every claim must trace back to a transcript passage or the class's actual behavior; a topic with no usable video coverage and an unclear class is left marked as still needing work rather than filled in from guesswork. The skill writes the doc file but never stages or commits it, leaving that review step to the person running it.
When your agent uses it
- Filling in a UI topic's empty help-panel doc after videos have been transcribed
- Writing hover text for a specific UI feature from the maintainer's own explanations
- Checking which topics still have no documentation body
- Fact-checking a drafted topic doc against its implementing class
Example prompts
- “Write the doc body for ui:Timeline using its transcript sources.”
- “List every UI topic that still has an empty help doc.”
- “Draft the hover help text for the keyframe editor topic.”
Requirements
- Stage 2 video transcription already run, populating mentions.json
- Python, to run the topic source-bundle script
Workflow steps
4 steps, taken from the step headings in SKILL.md.
What it can do on your machine
Read from SKILL.md and the folder at commit 0f65464. It shows what the files ask for, not the result of running them.
Tool permissions
Pre-approves nothing: there is no allowed-tools line, so your agent's usual permission prompts apply.
From allowed-tools in the SKILL.md frontmatter.
Runs code
Shell commands in SKILL.md call:
pythongit
From the folder's file list and the shell code blocks in SKILL.md.
Network
No URLs in SKILL.md. Its commands use git, which can reach the network depending on how they are called.
From URLs in SKILL.md, links to its own repository left out.
Credentials
Names no API keys, tokens, secrets or passwords.
From names ending in _API_KEY, _TOKEN, _SECRET, _KEY or _PASSWORD in SKILL.md.
Context cost
TiXL UI Topic Doc Writer loads about 952 tokens when it runs. Until then it costs about 114 tokens; SKILL.md has 484 words of instructions outside code blocks.
Estimates: characters ÷ 4, the usual rule of thumb; real counts depend on the model's tokenizer. Scripts and assets cost tokens only if the agent reads them.
Safety
Auto-check passed
The automated check found no risky patterns in SKILL.md.
Automated static check — not a guarantee. Review scripts before installing. It scans the text of SKILL.md for risky patterns (piping downloads into a shell, reading credential files, hidden Unicode, destructive commands); files beside SKILL.md are not scanned.
SKILL.md
The full file from tixl3d/tixl at commit 0f65464, republished under its MIT licence (© tixl3d). 484 words, ~952 tokens.
Download SKILL.mdSave it as
.claude/skills/write-topic-docs/SKILL.md (or your agent's skills folder).- name
- write-topic-docs
- description
- Draft the embedded help text for ui: topics whose doc is still empty. For each topic it gathers the transcript passages where the maintainer explains it (via the ui: deep-link index), the implementing class, and any existing .help/ page, then distills a short user-facing doc into .help/references/topics/ui-topics.md. Use after the videos are transcribed and analyzed (stage 2), when the user wants to write or fill in the ui topic docs.
write-topic-docs
STAGE 4 (authoring) of the docs pipeline. The ui: topic registry
(.help/references/topics/ui-topics.md) holds metadata + synonyms + class pointers; the doc body
of each topic is the help shown on hover / in the help panel. This skill fills the _TODO_ bodies —
sourced primarily from the maintainer's own video explanations, located via the ui: deep-link
index and fact-checked against the implementing class.
Run only after stage 2 (/analyze-videos) has populated mentions.json with [ui:Id] mentions —
without them there are no transcript passages to distill from. Full design: .agentic/DOCUMENTATION_ECOSYSTEM.md.
Hard invariants
- Never
git add/ commit. Write the docs; the user reviews and commits. - User-facing voice (
.help/docs/STYLE.md): plain English, second person, no marketing tone. - Never name the C# class in the prose. The class is your fact-check, not content — STYLE.md
keeps implementation detail out of
.help/. Operators go in[Brackets](the docs build auto-links them); bold a UI element on first mention. - Ground every claim in a source. Distill the transcript passages + class behaviour; don't invent
features. If a topic has no usable video coverage and the class is unclear, leave
_TODO_and flag it.
Step 1 — find the work
python .help/scripts/topic_doc_sources.py (no arg) lists every topic whose doc is still empty and
prints each one's source bundle. Target one with python .help/scripts/topic_doc_sources.py ui:Timeline.
Step 2 — read the source bundle (per topic)
The helper prints, for the topic: its classes, any existing .help/ page, and the top transcript
passages where it's discussed (ranked in-depth > explained > passing, most recent first) — each with
the video, timestamp and deep-link URL. That bundle is the raw material; prefer recent, in-depth
passages (a lone passing mention is usually too thin to write from).
Show full SKILL.md (211 more words)Show less
Step 3 — draft (per topic)
Spawn a subagent with the bundle (or draft directly for a single topic). Produce:
- First line: one sentence — what it is and when you'd reach for it. This is the hover text, so it must stand alone.
- a blank line, then 2–4 sentences: where to find it, the key actions/parameters, one practical tip. Second person; bold a UI element on first mention; bracket operators.
Open the classes file(s) only to verify terminology and behaviour — keep the code detail out of the
prose. If a fuller .help/ page exists, keep the embedded doc short and let that page carry detail.
Step 4 — write + refresh
- In
.help/references/topics/ui-topics.md, replace that topic's_TODO_with the drafted body, matching the## <Term>block so it lands on the right topic. - After the batch, run
python .help/scripts/analysis_to_index.pyto fold the docs intotopics.json. - Report which topics were written and which stayed
_TODO_for lack of sources. Nothing is committed — the user reviewsui-topics.mdand commits.
Notes
- Batch: loop Steps 2–3 over the empty-doc topics, write each as you go, run Step 4 once at the end.
- A meet-up demo distilled into a doc: per STYLE.md, the deep-link URL already records which video and moment it came from, so the cross-reference is preserved automatically.
© tixl3d, MIT. Rendered from Markdown: HTML in the file is shown as text, images as links, and headings moved down two levels. Raw file
Files
Just SKILL.md in .claude/skills/write-topic-docs of tixl3d/tixl.
Open the folder on GitHubat commit 0f65464
Compare with similar skills
TiXL UI Topic Doc Writer next to the 5 skills that share the most tags, products or categories with it. Stars are the repository's; “used in” counts other GitHub owners with a copy.
| Skill | Stars | Used in | Tokens | Auto-check | Licence | Repo updated |
|---|---|---|---|---|---|---|
| TiXL UI Topic Doc Writer this skilltixl3d/tixl | 5.1k | — | ~952 | Automated safety check: Pass | MIT | |
| Beads Documentation Style Guidegastownhall/beads | 28k | — | ~3.2k | Automated safety check: Pass | MIT | |
| Technical Writing Standardcursor/plugins | 10k | 10 repos | ~2.4k | Automated safety check: Pass | None | |
| Heym Documentation Articlesheymrun/heym | 1.4k | — | ~780 | Automated safety check: Pass | Custom licence | |
| Technical Writerfinos/morphir | 213 | — | ~4.4k | Automated safety check: Pass | Apache-2.0 | |
| Developer Docs Technical Writervercel-labs/github-tools | 131 | — | ~3.9k | Automated safety check: Pass | MIT |
Similar skills
- Official
Technical Writing Standard
cursor/plugins
Applies four layers of technical-writing rules to docs, RFCs, readmes, PR descriptions and commit messages so a tired engineer follows them on the first read.
Heym Documentation Articles
heymrun/heym
Creates and updates documentation articles for the Heym platform: category choice, manifest entry, markdown file and cross-links from existing pages.
Technical Writer
finos/morphir
Assists with writing and maintaining Morphir technical documentation.
- Official
Developer Docs Technical Writer
vercel-labs/github-tools
Writes, reviews and edits developer documentation for SDKs, libraries and frameworks, from getting-started guides and API references to migration guides.
Aholo Viewer Docs
manycoretech/aholo-viewer
Guides writing and maintaining Aholo Viewer documentation: README, AGENTS.md, architecture notes, bilingual manual pages and AI collaboration guides.
More from tixl3d/tixl
TiXL Video Operator Analysis
tixl3d/tixl
Turns transcribed TiXL tutorial videos into an exhaustive, timestamped list of every operator mention, feeding the documentation editor's deep-link index without touching the wiki or YouTube text.
TiXL Ticket Processor
tixl3d/tixl
Works through the In progress column of the TiXL road-map board unattended, turning simple tickets into git stashes and writing plans for the rest under .agentic/Plans.
Sentry Issue Fix Loop
tixl3d/tixl
Walks through open Sentry issues for the tooll3 project, latest first, proposing a fix for each and committing them one at a time with your review between.
TiXL Feature Review Stub
tixl3d/tixl
Review a TiXL feature or change set for elegance, naming, robustness (exceptions, null refs, initialization order, threading) and realtime performance…
Related
Categories
Questions about TiXL UI Topic Doc Writer
What does TiXL UI Topic Doc Writer do?
Fills in empty embedded help text for TiXL's UI topics by distilling the maintainer's own video explanations into short, user-facing doc entries. Is the fourth stage of a documentation pipeline, running only after an earlier video-transcription stage has populated a mentions file with topic references. For each topic still missing a doc body, a bundled Python script lists its source bundle: the implementing class, any existing help page, and the top transcript passages discussing it, ranked from in-depth to merely mentioned and sorted by recency.
When should I use TiXL UI Topic Doc Writer?
TiXL UI Topic Doc Writer fits situations like: filling in a UI topic's empty help-panel doc after videos have been transcribed; writing hover text for a specific UI feature from the maintainer's own explanations; checking which topics still have no documentation body; fact-checking a drafted topic doc against its implementing class.
How do I install TiXL UI Topic Doc Writer in Claude Code?
Run `npx skills add tixl3d/tixl --skill write-topic-docs -a claude-code`. Or copy the skill folder (.claude/skills/write-topic-docs in tixl3d/tixl) into .claude/skills/write-topic-docs in your project. Claude Code loads it when a task matches its description.
How do I install TiXL UI Topic Doc Writer in Codex?
Run `npx skills add tixl3d/tixl --skill write-topic-docs -a codex`. Or copy the skill folder (.claude/skills/write-topic-docs in tixl3d/tixl) into .agents/skills/write-topic-docs in your project. Codex loads it when a task matches its description.
Can I use TiXL UI Topic Doc Writer in Cursor, Gemini CLI or GitHub Copilot?
Cursor, Gemini CLI, GitHub Copilot and OpenCode also load SKILL.md folders. With the skills CLI, run `npx skills add tixl3d/tixl --skill write-topic-docs -a cursor` (or -a gemini-cli, github-copilot or opencode for the others). To copy it by hand, put the folder in .cursor/skills/write-topic-docs, .gemini/skills/write-topic-docs, .github/skills/write-topic-docs and .opencode/skills/write-topic-docs in your project.
What does TiXL UI Topic Doc Writer need to run?
Going by SKILL.md and its folder, TiXL UI Topic Doc Writer needs the command-line tools its instructions call (python and git). Our summary lists: Stage 2 video transcription already run, populating mentions.json; Python, to run the topic source-bundle script.
Does TiXL UI Topic Doc Writer access the network?
SKILL.md contains no URLs. Its commands use git, which can reach the network depending on how they are called. This is read from the text; nothing was executed.
Is TiXL UI Topic Doc Writer safe to install?
Our automated static check of SKILL.md found no risky patterns, such as piping downloads into a shell, reading credential files or hidden Unicode. It is not a guarantee. Review the folder before installing.
What licence does TiXL UI Topic Doc Writer use?
TiXL UI Topic Doc Writer is published under the MIT licence (the repository's licence). It allows redistribution, so the full SKILL.md is shown on this page.
How many tokens does TiXL UI Topic Doc Writer use?
About 952 tokens (SKILL.md is roughly 3.8k characters). Agents keep only the skill's name and description in context until a task matches; then they load SKILL.md in full.
What are the alternatives to TiXL UI Topic Doc Writer?
Skills that share tags, products or a category with TiXL UI Topic Doc Writer: Beads Documentation Style Guide (gastownhall/beads, 28k stars), Technical Writing Standard (cursor/plugins, 10k stars), Heym Documentation Articles (heymrun/heym, 1.4k stars) and Technical Writer (finos/morphir, 213 stars). The comparison table on this page puts their stars, adoption, token cost, safety result and licence side by side.
Who maintains TiXL UI Topic Doc Writer?
tixl3d (a GitHub organization) maintains it in tixl3d/tixl, which has 5,128 GitHub stars. The repository holds 5 skills in this directory. The repository was last updated on October 6, 2026.
Source: tixl3d/tixl on GitHub. Facts on this page come from the repository at the commit we read; the author's words are quoted as theirs.