Write, update, or review Serial Studio's user-facing documentation: the doc/help manual, README.md, and examples READMEs.

Custom licenceAuto-check passedDevelopment

Install Ss Docs

skills CLI
$ npx skills add Serial-Studio/Serial-Studio --skill ss-docs -a claude-code

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

GitHub CLI
$ gh skill install Serial-Studio/Serial-Studio ss-docs --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/Serial-Studio/Serial-Studio.git skills-src && mkdir -p .claude/skills && cp -r skills-src/.claude/skills/ss-docs .claude/skills/ss-docs && 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
ss-docs
GitHub stars
7.2k
Token cost
~1.6k tokens
SKILL.md length
751 words
Files
5 (incl. references)
Skills in repo
15
Repo updated
First seen
Licence
Custom licence

At a glance

Write, update, or review Serial Studio's user-facing documentation: the doc/help manual, README.md, and examples READMEs.

  • Works in 5 steps: The code is the ground truth. Every… → Manual voice, not blog voice.… → Linter-clean is necessary, not… → …
  • Asked to update the documentation
  • SKILL.md covers Invariants — name the ones…, Update workflow, Review workflow (read-only) and New-entry checklist, plus 1 more section
  • Calls python

What it does

Ss Docs is an agent skill from Serial-Studio/Serial-Studio. Write, update, or review Serial Studio's user-facing documentation: the doc/help manual, README.md, and examples READMEs. Use when asked to "update the documentation", "update the docs", "write a help entry", "review the documentation", "edit doc/help", "document <feature", or when touching any Markdown under doc/help/. Grounds every factual claim in code, mirrors the manual's voice and structure, registers new pages in help.json, and runs a two-tier AI-writing-tell check (documentation-verify.py first…

Its SKILL.md is about 1.6k tokens, which your agent loads only when the skill is triggered. The skill folder holds 5 other files, including reference files (for example `references/eeat-manual.md`, `references/ground-truth-factcheck.md` and `references/manual-heuristics.md`).

It sits in Development, covering Technical documentation and Humanizing AI text. The repository describes itself as: Open-source telemetry dashboard. Supports UART, BLE, MQTT, Modbus, CAN Bus and more.

When your agent uses it

  • Asked to update the documentation
  • Update the docs
  • Write a help entry
  • Review the documentation

Example prompts

  • “update the documentation”
  • “update the docs”
  • “write a help entry”
  • “/ss-docs”

Requirements

  • Python 3

Workflow steps

5 steps, taken from the first numbered list in SKILL.md.

  1. The code is the ground truth. Every default value, range, UI label, menu path, Pro
  2. Manual voice, not blog voice. Declarative present tense, no tutorial "we/let's", no
  3. Linter-clean is necessary, not sufficient. After the linter passes, run the structural
  4. Structure mirrors the neighbors. Read 1-2 sibling entries from the same help.json
  5. New pages register in doc/help/help.json (id, title, section, file) and

What it can do on your machine

Read from SKILL.md and the folder at commit 34c87a4. 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:

    • python

    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

Ss Docs loads about 1.6k tokens when it runs, and up to ~6k if it reads all its reference files. Until then it costs about 139 tokens; SKILL.md has 751 words of instructions outside code blocks.

Always · name and description, kept in context so the agent knows when to use it
~139
When it runs · the whole SKILL.md, loaded when a task matches
~1.6k
With references · SKILL.md plus every file in references/, read only if the agent opens them
~6k

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

Its licence (Custom licence) doesn't allow us to republish the file, so here is its outline and opening line. It has 751 words (~1,591 tokens).

“The manual competes with the code for the user's trust; a wrong default or a blog-voiced paragraph loses it. This skill covers doc/help/, README.md, and examples//README.md. The AI-facing material (CLAUDE.md, doc/claude/**, the skills) belongs to ss-ai-audit — don't restyle it…”

— opening of SKILL.md by Serial-Studio, Custom licence
name
ss-docs
argument-hint
[update <file> | review <file|dir> | new <topic>]

Read the full SKILL.md on GitHub

Files

SKILL.md and 4 other files (references) in .claude/skills/ss-docs of Serial-Studio/Serial-Studio.

  • SKILL.md
  • references/eeat-manual.md
  • references/ground-truth-factcheck.md
  • references/manual-heuristics.md
  • references/second-order-tells.md

Open the folder on GitHubat commit 34c87a4

Compare with similar skills

Ss Docs 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.

Ss Docs compared with similar skills
SkillStarsUsed inTokensAuto-checkLicenceRepo updated
Ss Docs this skillSerial-Studio/Serial-Studio7.2k—~1.6kAutomated safety check: PassCustom licence
Natural Writinga2ui-project/a2ui17k1 repos~2.1kAutomated safety check: PassApache-2.0
No TropesOutThisLife/brooklyn-skills198—~455Automated safety check: PassMIT
Human Writingkataras/jwt212—~1.9kAutomated safety check: PassMIT
Writewaynesutton/markdown-site628—~3kAutomated safety check: PassMIT
Writerrileyhilliard/claude-essentials130—~2kAutomated safety check: PassMIT

Similar skills

  • Natural Writing

    a2ui-project/a2ui

    Contains well-defined rules for creating natural, accurate, and readable writing.

    17k GitHub starsUsed in 1 repo~2.1k tokens
    DevelopmentAuto-check passed
  • No Tropes

    OutThisLife/brooklyn-skills

    Detect and eliminate common AI writing tropes from generated text.

    198 GitHub stars~455 tokensUpdated yesterday
    DevelopmentAuto-check passed
  • Human Writing

    kataras/jwt

    A skill your agent uses when writing or editing any prose in this repository - the book's preface, its chapters and epilogue, the brand kit notes, the agent skill documents, the changelog, and the…

    212 GitHub stars~1.9k tokensUpdated 24 days ago
    DevelopmentAuto-check passed
  • Write

    waynesutton/markdown-site

    Writing style guide for technical content, social media, blog posts, READMEs, git commits, and developer documentation.

    628 GitHub stars~3k tokensUpdated 4 mo ago
    Writing & ContentAuto-check passed
  • Writer

    rileyhilliard/claude-essentials

    Writing style and tone guide for human-sounding content. An agent skill from rileyhilliard/claude-essentials.

    130 GitHub stars~2k tokensUpdated 1 mo ago
    Writing & ContentAuto-check passed
  • Moonbit Docs Maintainer

    moonbitlang/moonbit-docs

    A skill your agent uses when maintaining the moonbitlang/moonbit-docs repository, including Sphinx docs under next/, MoonBit examples under next/sources/, error-code documentation, gettext…

    2.4k GitHub stars~1.1k tokensUpdated 16 days ago
    DevelopmentAuto-check passed

More from Serial-Studio/Serial-Studio

All 15 skills in this repo
  • Qt Cpp Review

    Serial-Studio/Serial-Studio

    Qt6/C++ deep code review for Serial Studio. An agent skill from Serial-Studio/Serial-Studio.

    7.2k GitHub stars~4.3k tokensUpdated yesterday
    Auto-check passed
  • Qt Qml Review

    Serial-Studio/Serial-Studio

    Qt6/QML deep code review for Serial Studio. An agent skill from Serial-Studio/Serial-Studio.

    7.2k GitHub stars~3.7k tokensUpdated yesterday
    Auto-check passed
  • Ss Spec

    Serial-Studio/Serial-Studio

    Phase 1 of Serial Studio's spec-driven workflow: capture WHAT a feature must do and WHY, with no implementation detail.

    7.2k GitHub stars~766 tokensUpdated yesterday
    Auto-check passed
  • Cpp Compiler Flags

    Serial-Studio/Serial-Studio

    C++ compiler/linker flag guidance for Serial Studio's build (GCC, Clang, AppleClang, MSVC cl.exe, clang-cl, MinGW, IntelLLVM).

    7.2k GitHub stars~2.1k tokensUpdated yesterday
    Auto-check passed
  • Ss Cpp Modern

    Serial-Studio/Serial-Studio

    Modern C++20 authoring guidance for Serial Studio (Qt 6.11, C++20): concepts, ranges, move/RAII, std smart pointers, constexpr, lock-free SPSC atomics.

    7.2k GitHub stars~1.6k tokensUpdated yesterday
    Auto-check passed
  • Qt Qml

    Serial-Studio/Serial-Studio

    QML authoring best practices for Serial Studio (Qt 6.11). An agent skill from Serial-Studio/Serial-Studio.

    7.2k GitHub stars~2.9k tokensUpdated yesterday
    Auto-check passed

Questions about Ss Docs

What does Ss Docs do?

Write, update, or review Serial Studio's user-facing documentation: the doc/help manual, README.md, and examples READMEs. Ss Docs is an agent skill from Serial-Studio/Serial-Studio.md, and examples READMEs.

When should I use Ss Docs?

Ss Docs fits situations like: asked to update the documentation; update the docs; write a help entry; review the documentation.

How do I install Ss Docs in Claude Code?

Run `npx skills add Serial-Studio/Serial-Studio --skill ss-docs -a claude-code`. Or copy the skill folder (.claude/skills/ss-docs in Serial-Studio/Serial-Studio) into .claude/skills/ss-docs in your project. Claude Code loads it when a task matches its description.

How do I install Ss Docs in Codex?

Run `npx skills add Serial-Studio/Serial-Studio --skill ss-docs -a codex`. Or copy the skill folder (.claude/skills/ss-docs in Serial-Studio/Serial-Studio) into .agents/skills/ss-docs in your project. Codex loads it when a task matches its description.

Can I use Ss Docs 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 Serial-Studio/Serial-Studio --skill ss-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/ss-docs, .gemini/skills/ss-docs, .github/skills/ss-docs and .opencode/skills/ss-docs in your project.

What does Ss Docs need to run?

Going by SKILL.md and its folder, Ss Docs needs the command-line tools its instructions call (python). Our summary lists: Python 3.

Does Ss Docs 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 Ss Docs 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 Ss Docs use?

Ss Docs has a licence file (the repository's licence) that doesn't match a standard licence. Read it on GitHub before reusing the skill.

How many tokens does Ss Docs use?

About 1.6k tokens (SKILL.md is roughly 6.4k characters). Agents keep only the skill's name and description in context until a task matches; then they load SKILL.md in full. Its references folder adds about 4.4k tokens, read only when the agent opens those files.

What are the alternatives to Ss Docs?

Skills that share tags, products or a category with Ss Docs: Natural Writing (a2ui-project/a2ui, 17k stars), No Tropes (OutThisLife/brooklyn-skills, 198 stars), Human Writing (kataras/jwt, 212 stars) and Write (waynesutton/markdown-site, 628 stars). The comparison table on this page puts their stars, adoption, token cost, safety result and licence side by side.

Who maintains Ss Docs?

Serial-Studio (a GitHub organization) maintains it in Serial-Studio/Serial-Studio, which has 7,224 GitHub stars. The repository holds 15 skills in this directory. The repository was last updated on October 6, 2026.

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