Agent skill

Docs Writing Style

by inkline in inkline/inkline

How Inkline documentation is written and kept true — the doc surface, pointers-not-duplicates, the drift watch with its current inventory, voice rules, and the future docs website.

No licenceAuto-check passedAgent Workflows

Install Docs Writing Style

skills CLI
$ npx skills add inkline/inkline --skill docs-writing-style -a claude-code

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

GitHub CLI
$ gh skill install inkline/inkline docs-writing-style --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/inkline/inkline.git skills-src && mkdir -p .claude/skills && cp -r skills-src/.claude/skills/docs-writing-style .claude/skills/docs-writing-style && 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
docs-writing-style
GitHub stars
1.5k
Token cost
~1.2k tokens
SKILL.md length
556 words
Files
1
Skills in repo
23
Repo updated
First seen
Licence
None found

At a glance

How Inkline documentation is written and kept true — the doc surface, pointers-not-duplicates, the drift watch with its current inventory, voice rules, and the future docs website.

  • Works in 4 steps: Pointers, not duplicates. Docs point at… → The cross-reference table in… → Link integrity is automated:… → …
  • Apps/website work
  • SKILL.md covers House principles (from…, The drift watch (this repo's…, Voice and The future website…, plus 1 more section
  • Calls pnpm

What it does

Docs Writing Style is an agent skill from inkline/inkline. How Inkline documentation is written and kept true — the doc surface, pointers-not-duplicates, the drift watch with its current inventory, voice rules, and the future docs website. Use for any docs/, AGENTS.md, README, or apps/website work.

Its SKILL.md is about 1.2k 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 Agent Workflows, covering Brand voice and tone, Agent instruction files and Technical documentation. It works with Vite. The repository describes itself as: Inkline is the intuitive UI Components library that gives you a developer-friendly foundation for building high-quality, accessible, and customizable Vue.js 3 Design Systems.

When your agent uses it

  • Apps/website work
  • Tasks that involve Brand voice and tone
  • Tasks that involve Agent instruction files

Example prompts

  • “/docs-writing-style”

Workflow steps

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

  1. Pointers, not duplicates. Docs point at canonical sources (vite.config.ts:lint, codes.ts, package.json:scripts) rather than restating…
  2. The cross-reference table in maintenance.md says which doc to update when X changes (compiler exports → README+AGENTS+architecture; CLI…
  3. Link integrity is automated: tooling/agents-check is a Vitest test that verifies the agent-facing doc surface's links/paths — it runs with…
  4. Every behavior-changing PR carries its doc updates. You back @warden's freshness gate: an API PR without its AGENTS.md/README update fails…

What it can do on your machine

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

    • pnpm

    From the folder's file list and the shell code blocks in SKILL.md.

  • Network

    No URLs in SKILL.md. Its commands use pnpm, 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

Docs Writing Style loads about 1.2k tokens when it runs. Until then it costs about 65 tokens; SKILL.md has 556 words of instructions outside code blocks.

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

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

Without a licence we can't republish the file, so here is its outline and opening line. It has 556 words (~1,163 tokens).

“The doc surface today: docs/*.md (architecture, conventions, contributing, release-process, maintenance, authoring-components), fourteen AGENTS.md files (root + per package — the agent/contributor entry points), core/compiler/README.md (the user-facing language reference), and .github templates. The public docs site (apps/website) is a Vite vanilla…”

— opening of SKILL.md by inkline
name
docs-writing-style

Read the full SKILL.md on GitHub

Files

Just SKILL.md in .claude/skills/docs-writing-style of inkline/inkline.

Open the folder on GitHubat commit f4da55a

Compare with similar skills

Docs Writing Style 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.

Docs Writing Style compared with similar skills
SkillStarsUsed inTokensAuto-checkLicenceRepo updated
Docs Writing Style this skillinkline/inkline1.5k—~1.2kAutomated safety check: PassNone
Dsh Web Documentationzhu1090093659/dsh-web8.5k—~479Automated safety check: PassApache-2.0
Neat-Freak Knowledge CloseoutKKKKhazix/khazix-skills21k—~1.9kAutomated safety check: PassMIT
Newprojectscunning1975/MixtapeTools4731 repos~850Automated safety check: PassNone
Sync Public DocsCaldis/react-zmage946—~3.3kAutomated safety check: PassMIT
Review DocsKaggle/kaggle-environments454—~2.7kAutomated safety check: PassApache-2.0

Similar skills

  • Dsh Web Documentation

    zhu1090093659/dsh-web

    A skill your agent uses when adding or editing dsh-web README files, docs, AGENTS.md instructions, user-facing configuration text, or bilingual documentation pairs.

    8.5k GitHub stars~479 tokensUpdated today
    Agent WorkflowsAuto-check passed
  • Neat-Freak Knowledge Closeout

    KKKKhazix/khazix-skills

    Brings project docs, agent rule files, authorized memory and leftover workspace files back in line with what the code and runtime actually do at the end of a work session.

    21k GitHub stars~1.9k tokensUpdated 8 days ago
    Agent WorkflowsAuto-check passed
  • Newproject

    scunning1975/MixtapeTools

    Scaffold a new research project with standard directory structure, CLAUDE.md template, and documented README.

    473 GitHub starsUsed in 1 repo~850 tokens
    Agent WorkflowsAuto-check passed
  • Sync Public Docs

    Caldis/react-zmage

    A skill your agent uses when modifying public API in packages/core (types/global.ts, types/default.ts, index.ts, or package.json exports field), adding/renaming/removing props, changing default…

    946 GitHub stars~3.3k tokensUpdated 4 mo ago
    Agent WorkflowsAuto-check passed
  • Review Docs

    Kaggle/kaggle-environments

    Audit a game environment's README.md and AGENTS.md against its engine implementation.

    454 GitHub stars~2.7k tokensUpdated yesterday
    Agent WorkflowsAuto-check passed
  • Documentation

    samchon/typia

    Defines README, website-guide, and agent-instruction structure, audience, prose formatting, and voice for typia.

    5.9k GitHub stars~1.1k tokensUpdated 3 days ago
    Agent WorkflowsAuto-check passed

More from inkline/inkline

All 23 skills in this repo
  • Adversarial QA

    inkline/inkline

    Repro-first QA for Inkline — minimal .ink.tsx reproductions, the visual-parity and cross-target harnesses, fuzz targets, and how to audit teammates' claims.

    1.5k GitHub stars~1.2k tokensUpdated 28 days ago
    Auto-check passed
  • Benchmark Protocol

    inkline/inkline

    How Inkline measures itself — compile performance, output size and quality vs hand-written components and Mitosis, fairness rules, and reporting format.

    1.5k GitHub stars~955 tokensUpdated 28 days ago
    Auto-check passed
  • The Inkline compiler's end-to-end pipeline — parse → IR → analyze → per-target codegen → print — including the IR contracts, reactivity tracking, target rewrite rules, plugin hooks, the two compile…

    1.5k GitHub stars~1.9k tokensUpdated 28 days ago
    Auto-check passed
  • Component Catalog

    inkline/inkline

    How Inkline components are built and kept consistent — the headless/styled split, family anatomy, prop/axis conventions, recipe consumption, the current 5-family catalog and its gap list.

    1.5k GitHub stars~1.4k tokensUpdated 28 days ago
    Auto-check passed
  • Create PR

    inkline/inkline

    Author a pull request in the Guild's standard shape — a fixed Summary / Changes / Verification / Notes skeleton that mirrors the review-gate, plus the hard anti-leak rule that no agent @mention or…

    1.5k GitHub stars~1.7k tokensUpdated 28 days ago
    Auto-check passed
  • How design tokens and recipes flow from styleframe into Inkline — the presets, the two faces of virtual:styleframe, recipe class contracts, theming, and the rules for custom CSS in components.

    1.5k GitHub stars~1.2k tokensUpdated 28 days ago
    Auto-check passed

Works with

Questions about Docs Writing Style

What does Docs Writing Style do?

How Inkline documentation is written and kept true — the doc surface, pointers-not-duplicates, the drift watch with its current inventory, voice rules, and the future docs website. Docs Writing Style is an agent skill from inkline/inkline. How Inkline documentation is written and kept true — the doc surface, pointers-not-duplicates, the drift watch with its current inventory, voice rules, and the future docs website.

When should I use Docs Writing Style?

Docs Writing Style fits situations like: apps/website work; tasks that involve Brand voice and tone; tasks that involve Agent instruction files.

How do I install Docs Writing Style in Claude Code?

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

How do I install Docs Writing Style in Codex?

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

Can I use Docs Writing Style 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 inkline/inkline --skill docs-writing-style -a cursor` (or -a gemini-cli, github-copilot or opencode for the others). To copy it by hand, put the folder in .cursor/skills/docs-writing-style, .gemini/skills/docs-writing-style, .github/skills/docs-writing-style and .opencode/skills/docs-writing-style in your project.

What does Docs Writing Style need to run?

Going by SKILL.md and its folder, Docs Writing Style needs the command-line tools its instructions call (pnpm).

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

No licence was found for Docs Writing Style or its repository. Without one, default copyright applies: ask the author before reusing or redistributing it.

How many tokens does Docs Writing Style use?

About 1.2k tokens (SKILL.md is roughly 4.7k 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 Docs Writing Style?

Skills that share tags, products or a category with Docs Writing Style: Dsh Web Documentation (zhu1090093659/dsh-web, 8.5k stars), Neat-Freak Knowledge Closeout (KKKKhazix/khazix-skills, 21k stars), Newproject (scunning1975/MixtapeTools, 473 stars) and Sync Public Docs (Caldis/react-zmage, 946 stars). The comparison table on this page puts their stars, adoption, token cost, safety result and licence side by side.

Who maintains Docs Writing Style?

inkline (a GitHub organization) maintains it in inkline/inkline, which has 1,469 GitHub stars. The repository holds 23 skills in this directory. The repository was last updated on September 11, 2026.

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