Agent skill

Technical Writer

by RightNow-AI in RightNow-AI/openfang

Technical writing expert for API docs, READMEs, ADRs, and developer documentation

Apache-2.0Auto-check passedWriting & Content

Install Technical Writer

skills CLI
$ npx skills add RightNow-AI/openfang --skill technical-writer -a claude-code

Project install by default; add -g for ~/.claude/skills/.

GitHub CLI
$ gh skill install RightNow-AI/openfang technical-writer --agent claude-code

Project scope by default; add --scope user for a personal install. Needs GitHub CLI 2.90.0 or later (public preview).

Manual copy
$ git clone --depth 1 https://github.com/RightNow-AI/openfang.git skills-src && mkdir -p .claude/skills && cp -r skills-src/crates/openfang-skills/bundled/technical-writer .claude/skills/technical-writer && rm -rf skills-src

Use ~/.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/

Facts

Skill name
technical-writer
GitHub stars
18k
Token cost
~891 tokens
SKILL.md length
452 words
Files
1
Skills in repo
68
Repo updated
First seen
Licence
Apache-2.0

At a glance

Technical writing expert for API docs, READMEs, ADRs, and developer documentation

  • Tasks that involve Technical writing
  • SKILL.md covers Key Principles, Techniques, Common Patterns and Pitfalls to Avoid
  • Instructions only: no scripts, shell commands, URLs or credentials in SKILL.md
  • Tasks that involve Technical documentation

What it does

Technical Writer is an agent skill from RightNow-AI/openfang. Technical writing expert for API docs, READMEs, ADRs, and developer documentation

Its SKILL.md is about 890 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, Technical documentation and Architecture decision records. The repository describes itself as: Open-source Agent Operating System. The licence is Apache-2.0.

When your agent uses it

  • Tasks that involve Technical writing
  • Tasks that involve Technical documentation
  • Tasks that involve Architecture decision records

Example prompts

  • “/technical-writer”

What it can do on your machine

Read from SKILL.md and the folder at commit acf2587. 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 Writer loads about 891 tokens when it runs. Until then it costs about 25 tokens; SKILL.md has 452 words of instructions outside code blocks.

Always · name and description, kept in context so the agent knows when to use it
~25
When it runs · the whole SKILL.md, loaded when a task matches
~891

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 RightNow-AI/openfang at commit acf2587, republished under its Apache-2.0 licence (© RightNow-AI). 452 words, ~891 tokens.

Download SKILL.mdSave it as .claude/skills/technical-writer/SKILL.md (or your agent's skills folder).
name
technical-writer
description
Technical writing expert for API docs, READMEs, ADRs, and developer documentation

Technical Writing Expertise

You are a senior technical writer specializing in developer documentation, API references, architecture decision records, and onboarding materials. You follow the Diataxis framework to categorize documentation into tutorials, how-to guides, reference material, and explanations. You write with clarity, precision, and empathy for the reader, understanding that documentation is the product's user interface for developers.

Key Principles

  • Write for the reader's context: what do they know, what do they need to accomplish, and what is the fastest path to get them there
  • Separate the four documentation modes: tutorials (learning), how-to guides (problem-solving), reference (information), and explanation (understanding)
  • Every code example must be complete, runnable, and tested; broken examples destroy trust faster than missing documentation
  • Use consistent terminology throughout; define terms on first use and maintain a glossary for domain-specific vocabulary
  • Keep documentation close to the code it describes; colocated docs are updated more frequently than docs in separate repositories

Techniques

  • Structure READMEs with: project name and one-line description, badges (CI, coverage, version), installation instructions, quick-start example, API overview, contributing guide, and license
  • Write API reference entries with: endpoint/function signature, parameter descriptions with types and defaults, return value description, error conditions, and a working example
  • Create Architecture Decision Records (ADRs) with: title, status (proposed/accepted/deprecated), context, decision, and consequences sections
  • Follow changelog conventions (Keep a Changelog format): group entries under Added, Changed, Deprecated, Removed, Fixed, Security headers
  • Use second person ("you") for instructional content and present tense for descriptions; avoid passive voice and jargon without definition
  • Include diagrams (Mermaid, PlantUML) for architecture overviews, sequence flows, and state machines; a diagram is worth a thousand words of prose
Show full SKILL.md (185 more words)Show less

Common Patterns

  • Progressive Disclosure: Start with the simplest possible example, then layer in configuration options, error handling, and advanced features in subsequent sections
  • Task-Oriented Headings: Use headings that match what the reader is trying to do: "Configure TLS certificates" rather than "TLS Configuration" or "About TLS"
  • Copy-Paste Verification: Test every code snippet by copying it from the rendered documentation and running it in a clean environment; formatting artifacts break examples
  • Version-Aware Documentation: Clearly label features by the version that introduced them; use admonitions (Note, Warning, Since v2.3) for version-specific behavior

Pitfalls to Avoid

  • Do not write documentation that only describes what the code does (the code already does that); explain why decisions were made and when to use each option
  • Do not mix tutorial and reference styles in the same document; a tutorial walks through a specific scenario while a reference enumerates all options exhaustively
  • Do not use screenshots for text-based content (CLI output, configuration files); screenshots cannot be searched, copied, or updated without image editing tools
  • Do not defer documentation to "later"; undocumented features are invisible features that accumulate technical debt in onboarding time

© RightNow-AI, 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 crates/openfang-skills/bundled/technical-writer of RightNow-AI/openfang.

Open the folder on GitHubat commit acf2587

Compare with similar skills

Technical 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.

Technical Writer compared with similar skills
SkillStarsUsed inTokensAuto-checkLicenceRepo updated
Technical Writer this skillRightNow-AI/openfang18k—~891Automated safety check: PassApache-2.0
Diataxis Docspmndrs/glyph395—~1.4kAutomated safety check: PassMIT
RFC Creatortech-leads-club/agent-skills7k—~2.9kAutomated safety check: PassCC-BY-4.0
Technical Writingrsmdt/the-startup557—~1.3kAutomated safety check: PassMIT
Beads Documentation Style Guidegastownhall/beads28k—~3.2kAutomated safety check: PassMIT
Technical Writing Standardcursor/plugins10k10 repos~2.4kAutomated safety check: PassNone

Similar skills

  • Diataxis Docs

    pmndrs/glyph

    Design, classify, write, audit, or restructure technical documentation with the Diátaxis framework.

    395 GitHub stars~1.4k tokensUpdated today
    DevelopmentAuto-check passed
  • RFC Creator

    tech-leads-club/agent-skills

    Drafts Request for Comments documents that lay out a proposal, the options weighed and the decision needed, so approvers can align before a major change.

    7k GitHub stars~2.9k tokensUpdated yesterday
    DevelopmentAuto-check passed
  • Technical Writing

    rsmdt/the-startup

    Create architectural decision records (ADRs), system documentation, API documentation, and operational runbooks.

    557 GitHub stars~1.3k tokensUpdated 2 mo ago
    DevelopmentAuto-check passed
  • 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.

    28k GitHub stars~3.2k tokensUpdated today
    Writing & ContentAuto-check passed
  • Official

    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.

    10k GitHub starsUsed in 10 repos~2.4k tokens
    Writing & ContentAuto-check passed
  • Creates and updates documentation articles for the Heym platform: category choice, manifest entry, markdown file and cross-links from existing pages.

    1.4k GitHub stars~780 tokensUpdated today
    Writing & ContentAuto-check passed

More from RightNow-AI/openfang

All 68 skills in this repo
  • Reference of CSS selectors, step-by-step web workflows and error recovery tactics for an agent that browses, fills forms and compares prices on live sites.

    18k GitHub stars~1k tokensUpdated 3 mo ago
    Auto-check passed
  • Reference knowledge for open-source intelligence collection: the collection cycle, source reliability tiers, search query patterns and entity extraction.

    18k GitHub stars~2.1k tokensUpdated 3 mo ago
    Auto-check passed
  • Lead Generation Research Guide

    RightNow-AI/openfang

    Reference knowledge for AI lead generation: building an ideal customer profile, researching prospects on the web, enriching lead records and finding email formats.

    18k GitHub stars~1.8k tokensUpdated 3 mo ago
    Auto-check passed
  • Video Clipping Reference

    RightNow-AI/openfang

    Command reference for cutting clips from online video: yt-dlp downloads, whisper transcription, SRT subtitle files and ffmpeg processing, with Windows, macOS and Linux differences.

    18k GitHub stars~4.1k tokensUpdated 3 mo ago
    Auto-check: warnings
  • Forecasting Expert Knowledge

    RightNow-AI/openfang

    Reference knowledge for AI forecasting: superforecasting principles, a signal taxonomy, confidence calibration rules and reasoning chains for making and tracking predictions.

    18k GitHub stars~2.5k tokensUpdated 3 mo ago
    Auto-check passed
  • Deep Research Methodology

    RightNow-AI/openfang

    Reference knowledge for AI deep research: a five-phase process, strategies by question type, CRAAP source scoring, cross-referencing, synthesis and citation formats.

    18k GitHub stars~2.6k tokensUpdated 3 mo ago
    Auto-check passed

Questions about Technical Writer

What does Technical Writer do?

Technical writing expert for API docs, READMEs, ADRs, and developer documentation. Technical Writer is an agent skill from RightNow-AI/openfang.

When should I use Technical Writer?

Technical Writer fits situations like: tasks that involve Technical writing; tasks that involve Technical documentation; tasks that involve Architecture decision records.

How do I install Technical Writer in Claude Code?

Run `npx skills add RightNow-AI/openfang --skill technical-writer -a claude-code`. Or copy the skill folder (crates/openfang-skills/bundled/technical-writer in RightNow-AI/openfang) into .claude/skills/technical-writer in your project. Claude Code loads it when a task matches its description.

How do I install Technical Writer in Codex?

Run `npx skills add RightNow-AI/openfang --skill technical-writer -a codex`. Or copy the skill folder (crates/openfang-skills/bundled/technical-writer in RightNow-AI/openfang) into .agents/skills/technical-writer in your project. Codex loads it when a task matches its description.

Can I use Technical 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 RightNow-AI/openfang --skill technical-writer -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-writer, .gemini/skills/technical-writer, .github/skills/technical-writer and .opencode/skills/technical-writer in your project.

What does Technical Writer need to run?

SKILL.md names no scripts, command-line tools or credentials: Technical Writer is instructions for the agent only.

Does Technical Writer 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 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 Technical Writer use?

Technical Writer 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 Writer use?

About 891 tokens (SKILL.md is roughly 3.6k 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 Writer?

Skills that share tags, products or a category with Technical Writer: Diataxis Docs (pmndrs/glyph, 395 stars), RFC Creator (tech-leads-club/agent-skills, 7k stars), Technical Writing (rsmdt/the-startup, 557 stars) and Beads Documentation Style Guide (gastownhall/beads, 28k stars). The comparison table on this page puts their stars, adoption, token cost, safety result and licence side by side.

Who maintains Technical Writer?

RightNow-AI (a GitHub organization) maintains it in RightNow-AI/openfang, which has 18,216 GitHub stars. The repository holds 68 skills in this directory. The repository was last updated on July 2, 2026.

Source: RightNow-AI/openfang on GitHub. Facts on this page come from the repository at the commit we read; the author's words are quoted as theirs.