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.
Guidelines for writing clear, professional technical documentation
Install Technical Writing
$ npx skills add brevdev/workshop-build-an-agent --skill technical-writing -a claude-codeProject install by default; add -g for ~/.claude/skills/.
$ gh skill install brevdev/workshop-build-an-agent technical-writing --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/brevdev/workshop-build-an-agent.git skills-src && mkdir -p .claude/skills && cp -r skills-src/skills/technical-writing .claude/skills/technical-writing && 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 "technical-writing" agent skill from https://github.com/brevdev/workshop-build-an-agent/tree/main/skills/technical-writing into .claude/skills/technical-writing/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "technical-writing", 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/brevdev/workshop-build-an-agent/tree/main/skills/technical-writingType 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 brevdev/workshop-build-an-agent --skill technical-writing -a codexProject install goes to .agents/skills/; add -g for ~/.codex/skills/.
$ gh skill install brevdev/workshop-build-an-agent technical-writing --agent codexProject scope by default (.agents/skills/); add --scope user for a personal install.
$ git clone --depth 1 https://github.com/brevdev/workshop-build-an-agent.git skills-src && mkdir -p .agents/skills && cp -r skills-src/skills/technical-writing .agents/skills/technical-writing && rm -rf skills-srcUse ~/.agents/skills/ instead of .agents/skills for a personal install.
Codex skills documentation · loads skills from .agents/skills/
Install the "technical-writing" agent skill from https://github.com/brevdev/workshop-build-an-agent/tree/main/skills/technical-writing into .agents/skills/technical-writing/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "technical-writing", 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 brevdev/workshop-build-an-agent --skill technical-writing -a cursorProject install goes to .agents/skills/; add -g for ~/.cursor/skills/.
$ gh skill install brevdev/workshop-build-an-agent technical-writing --agent cursorProject scope by default (.agents/skills/); add --scope user for a personal install.
$ git clone --depth 1 https://github.com/brevdev/workshop-build-an-agent.git skills-src && mkdir -p .cursor/skills && cp -r skills-src/skills/technical-writing .cursor/skills/technical-writing && 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 "technical-writing" agent skill from https://github.com/brevdev/workshop-build-an-agent/tree/main/skills/technical-writing into .cursor/skills/technical-writing/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "technical-writing", 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/brevdev/workshop-build-an-agent.git --path skills/technical-writing--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 brevdev/workshop-build-an-agent --skill technical-writing -a gemini-cliProject install goes to .agents/skills/; add -g for ~/.gemini/skills/.
$ gh skill install brevdev/workshop-build-an-agent technical-writing --agent gemini-cliProject scope by default (.agents/skills/); add --scope user for a personal install.
$ git clone --depth 1 https://github.com/brevdev/workshop-build-an-agent.git skills-src && mkdir -p .gemini/skills && cp -r skills-src/skills/technical-writing .gemini/skills/technical-writing && 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 "technical-writing" agent skill from https://github.com/brevdev/workshop-build-an-agent/tree/main/skills/technical-writing into .gemini/skills/technical-writing/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "technical-writing", 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 brevdev/workshop-build-an-agent technical-writingInstalls 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 brevdev/workshop-build-an-agent --skill technical-writing -a github-copilotProject install goes to .agents/skills/; add -g for ~/.copilot/skills/.
$ git clone --depth 1 https://github.com/brevdev/workshop-build-an-agent.git skills-src && mkdir -p .github/skills && cp -r skills-src/skills/technical-writing .github/skills/technical-writing && 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 "technical-writing" agent skill from https://github.com/brevdev/workshop-build-an-agent/tree/main/skills/technical-writing into .github/skills/technical-writing/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "technical-writing", 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 brevdev/workshop-build-an-agent --skill technical-writing -a opencodeOpenCode documents no install command of its own. Project install goes to .agents/skills/; add -g for ~/.config/opencode/skills/.
$ gh skill install brevdev/workshop-build-an-agent technical-writing --agent opencodeProject scope by default (.agents/skills/); add --scope user for a personal install.
$ git clone --depth 1 https://github.com/brevdev/workshop-build-an-agent.git skills-src && mkdir -p .opencode/skills && cp -r skills-src/skills/technical-writing .opencode/skills/technical-writing && 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 "technical-writing" agent skill from https://github.com/brevdev/workshop-build-an-agent/tree/main/skills/technical-writing into .opencode/skills/technical-writing/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "technical-writing", 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
technical-writing- GitHub stars
- 143
- Token cost
- ~276 tokens
- SKILL.md length
- 132 words
- Files
- 1
- Skills in repo
- 11
- Repo updated
- First seen
- Licence
- Apache-2.0
At a glance
Guidelines for writing clear, professional technical documentation
- Works in 4 steps: Executive Summary - Start with a brief… → Key Points - Use bullet points for… → Details - Expand on each point with… → …
- Tasks that involve Technical writing
- SKILL.md covers Structure, Style Guidelines, Formatting and Quality Checklist
- Instructions only: no scripts, shell commands, URLs or credentials in SKILL.md
What it does
Technical Writing is an agent skill from brevdev/workshop-build-an-agent. Guidelines for writing clear, professional technical documentation
Its SKILL.md is about 280 tokens, which your agent loads only when the skill is triggered. It is a single SKILL.md file with no bundled scripts.
It sits in Writing & Content, covering Technical writing and Technical documentation. The licence is Apache-2.0.
When your agent uses it
- Tasks that involve Technical writing
- Tasks that involve Technical documentation
Example prompts
- “Use the technical-writing skill to guideline for writing clear, professional technical documentation”
- “/technical-writing”
Workflow steps
4 steps, taken from the first numbered list in SKILL.md.
- Executive Summary - Start with a brief overview (2-3 sentences)
- Key Points - Use bullet points for scannable content
- Details - Expand on each point with specifics
- Conclusion - Summarize actionable takeaways
What it can do on your machine
Read from SKILL.md and the folder at commit b5689a7. 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
No scripts in the folder and no shell commands in SKILL.md.
From the folder's file list and the shell code blocks in SKILL.md.
Network
No URLs in SKILL.md.
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
Technical Writing loads about 276 tokens when it runs. Until then it costs about 21 tokens; SKILL.md has 132 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 brevdev/workshop-build-an-agent at commit b5689a7, republished under its Apache-2.0 licence (© brevdev). 132 words, ~276 tokens.
Download SKILL.mdSave it as
.claude/skills/technical-writing/SKILL.md (or your agent's skills folder).- name
- technical-writing
- description
- Guidelines for writing clear, professional technical documentation
Technical Writing Skill
You are now operating as a technical writer. Follow these guidelines for all documentation tasks.
Structure
- Executive Summary - Start with a brief overview (2-3 sentences)
- Key Points - Use bullet points for scannable content
- Details - Expand on each point with specifics
- Conclusion - Summarize actionable takeaways
Style Guidelines
- Use active voice ("The system processes..." not "Data is processed by...")
- Keep sentences under 25 words
- Define acronyms on first use
- Use concrete examples over abstract explanations
Formatting
- Use headers (##, ###) to organize sections
- Code blocks for any technical content
- Tables for comparisons
- Bold for key terms, italics for emphasis
Quality Checklist
Before finishing, verify:
- Executive summary captures the main point
- All claims are supported by evidence or sources
- No jargon without explanation
- Clear next steps or call to action
© brevdev, Apache-2.0. 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 skills/technical-writing of brevdev/workshop-build-an-agent.
Open the folder on GitHubat commit b5689a7
Compare with similar skills
Technical Writing 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 |
|---|---|---|---|---|---|---|
| Technical Writing this skillbrevdev/workshop-build-an-agent | 143 | — | ~276 | Automated safety check: Pass | Apache-2.0 | |
| Beads Documentation Style Guidegastownhall/beads | 28k | — | ~3.2k | Automated safety check: Pass | MIT | |
| JavaScript Concept Page Workflowleonardomso/33-js-concepts | 67k | — | ~3.9k | 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 | |
| JavaScript Concept Page Writerleonardomso/33-js-concepts | 67k | — | ~14k | Automated safety check: Pass | MIT |
Similar skills
JavaScript Concept Page Workflow
leonardomso/33-js-concepts
Orchestrates five skills to produce a complete JavaScript concept documentation page, from resource curation through writing, tests, fact-checking and SEO.
- 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.
JavaScript Concept Page Writer
leonardomso/33-js-concepts
Writes or reviews documentation pages for the 33 JavaScript Concepts project, following its structure, a beginner-friendly voice and rules against AI-sounding language.
Technical Writing Workflow
tokenbender/agent-guides
A skill your agent uses for planning, researching, drafting, revising, or auditing technical write-ups, textbooks, papers, reports, READMEs, research notes, PR narratives, and public technical prose.
More from brevdev/workshop-build-an-agent
All 11 skills in this repoSetup Workshop
brevdev/workshop-build-an-agent
This skill should be used when the user wants to set up, install, deploy, bootstrap, or "spin up" the Build-an-Agent workshop (a.k.a.
Setup Workshop Nemoclaw
brevdev/workshop-build-an-agent
Set up the NVIDIA "Build an Agent" DevX workshop as a working JupyterLab environment from INSIDE a locked-down OpenShell/NemoClaw sandbox, and hand the user the token URL + access commands.
Nvwb
brevdev/workshop-build-an-agent
Manage NVIDIA AI Workbench projects, contexts, builds, and environments via the nvwb CLI.
Module 1
brevdev/workshop-build-an-agent
This skill should be used when a learner is working through Module 1 ("Build an Agent") of the Build-an-Agent workshop and wants help understanding the concepts, notebooks, or code — e.g.
Module 1
brevdev/workshop-build-an-agent
This skill should be used when a learner is working through Module 1 ("Build an Agent") of the Build-an-Agent workshop and wants help understanding the concepts, notebooks, or code — e.g.
Workshop
brevdev/workshop-build-an-agent
This skill should be used when a learner wants to navigate or understand the Build-an-Agent workshop as a whole — e.g.
Related
Categories
Questions about Technical Writing
What does Technical Writing do?
Guidelines for writing clear, professional technical documentation. Technical Writing is an agent skill from brevdev/workshop-build-an-agent.
When should I use Technical Writing?
Technical Writing fits situations like: tasks that involve Technical writing; tasks that involve Technical documentation.
How do I install Technical Writing in Claude Code?
Run `npx skills add brevdev/workshop-build-an-agent --skill technical-writing -a claude-code`. Or copy the skill folder (skills/technical-writing in brevdev/workshop-build-an-agent) into .claude/skills/technical-writing in your project. Claude Code loads it when a task matches its description.
How do I install Technical Writing in Codex?
Run `npx skills add brevdev/workshop-build-an-agent --skill technical-writing -a codex`. Or copy the skill folder (skills/technical-writing in brevdev/workshop-build-an-agent) into .agents/skills/technical-writing in your project. Codex loads it when a task matches its description.
Can I use Technical Writing 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 brevdev/workshop-build-an-agent --skill technical-writing -a cursor` (or -a gemini-cli, github-copilot or opencode for the others). To copy it by hand, put the folder in .cursor/skills/technical-writing, .gemini/skills/technical-writing, .github/skills/technical-writing and .opencode/skills/technical-writing in your project.
What does Technical Writing need to run?
SKILL.md names no scripts, command-line tools or credentials: Technical Writing is instructions for the agent only.
Does Technical Writing access the network?
SKILL.md contains no URLs. Any network use would come from the scripts or tools the agent runs. This is read from the text; nothing was executed.
Is Technical Writing 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 Technical Writing use?
Technical Writing is published under the Apache-2.0 licence (the repository's licence). It allows redistribution, so the full SKILL.md is shown on this page.
How many tokens does Technical Writing use?
About 276 tokens (SKILL.md is roughly 1.1k 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 Technical Writing?
Skills that share tags, products or a category with Technical Writing: Beads Documentation Style Guide (gastownhall/beads, 28k stars), JavaScript Concept Page Workflow (leonardomso/33-js-concepts, 67k stars), Technical Writing Standard (cursor/plugins, 10k stars) and Heym Documentation Articles (heymrun/heym, 1.4k stars). The comparison table on this page puts their stars, adoption, token cost, safety result and licence side by side.
Who maintains Technical Writing?
brevdev (a GitHub organization) maintains it in brevdev/workshop-build-an-agent, which has 143 GitHub stars. The repository holds 11 skills in this directory. The repository was last updated on October 6, 2026.
Source: brevdev/workshop-build-an-agent on GitHub. Facts on this page come from the repository at the commit we read; the author's words are quoted as theirs.