Agent skill

Documentation Writing

by radix-ng in radix-ng/primitives

Maintain project documentation in .claude/skills/project-knowledge/: audit, edit, check consistency, track status.

MITAuto-check passedWriting & Content

Install Documentation Writing

skills CLI
$ npx skills add radix-ng/primitives --skill documentation-writing -a claude-code

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

GitHub CLI
$ gh skill install radix-ng/primitives documentation-writing --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/radix-ng/primitives.git skills-src && mkdir -p .claude/skills && cp -r skills-src/.claude/skills/documentation-writing .claude/skills/documentation-writing && 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
documentation-writing
GitHub stars
274
Token cost
~1.4k tokens
SKILL.md length
626 words
Files
1
Skills in repo
7
Repo updated
First seen
Licence
MIT

At a glance

Maintain project documentation in .claude/skills/project-knowledge/: audit, edit, check consistency, track status.

  • Works in 4 steps: Audit → Edit → Check Consistency → …
  • : проверь документацию
  • SKILL.md covers Documentation Principles, File Structure, Workflows and Root Project Files, plus 1 more section
  • Instructions only: no scripts, shell commands, URLs or credentials in SKILL.md

What it does

Documentation Writing is an agent skill from radix-ng/primitives. Maintain project documentation in .claude/skills/project-knowledge/: audit, edit, check consistency, track status. Use when: "проверь документацию", "обнови документацию", "аудит документации", "check docs", "audit documentation", "update docs", "проверь базу знаний проекта" For creating documentation from scratch use project-planning skill. For reading docs or explaining concepts, read project-knowledge skill directly.

Its SKILL.md is about 1.4k 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 Project management. The repository describes itself as: Headless, signals-first UI primitives for Angular. Accessible. Customizable. The licence is MIT.

When your agent uses it

  • : проверь документацию
  • Обнови документацию
  • Аудит документации
  • Audit documentation

Example prompts

  • “check docs”
  • “audit documentation”
  • “update docs”
  • “/documentation-writing”

Workflow steps

4 steps, taken from the step headings in SKILL.md.

  1. Audit
  2. Edit
  3. Check Consistency
  4. Show Status

What it can do on your machine

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

Documentation Writing loads about 1.4k tokens when it runs. Until then it costs about 112 tokens; SKILL.md has 626 words of instructions outside code blocks.

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

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 radix-ng/primitives at commit eed2a31, republished under its MIT licence (© radix-ng). 626 words, ~1,447 tokens.

Download SKILL.mdSave it as .claude/skills/documentation-writing/SKILL.md (or your agent's skills folder).
name
documentation-writing
description
Maintain project documentation in .claude/skills/project-knowledge/: audit, edit, check consistency, track status. Use when: "проверь документацию", "обнови документацию", "аудит документации", "check docs", "audit documentation", "update docs", "проверь базу знаний проекта" For creating documentation from scratch use project-planning skill. For reading docs or explaining concepts, read project-knowledge skill directly.

Documentation Management

Maintain project documentation in .claude/skills/project-knowledge/references/. Audit for bloat, edit files, check consistency, track status.

For creating documentation from scratch (new project or empty docs), use project-planning skill.

Documentation Principles

These rules apply to ALL documentation operations (audit, edit, create).

Goal: open docs → understand the project without reading code. What is this project, how it's structured, what it does, where to find key things, how to deploy, where are logs. A high-level navigation guide.

Describe what exists, what it does, and why. High-level overview of components, how they work together, decisions made (why this stack, why this architecture), operational details (server addresses, deploy procedures, log locations, env var names). Skip what's obvious from reading the code itself — function signatures, implementation details, generic framework behavior.

No code blocks, no pseudocode. Code in docs gets outdated and bloats context.

No duplication between files. Information lives in ONE place. Cross-reference: "See deployment.md for env vars."

patterns.md: only project-specific patterns. Universal coding standards. Project patterns.md contains only what's unique to THIS project.

File Structure

4 core files in .claude/skills/project-knowledge/references/:

FileContains
project.mdOverview, audience, problem, 3-5 key features, out of scope
architecture.mdTech stack (with WHY), project structure, dependencies, integrations, data model
patterns.mdProject-specific code patterns, git workflow, testing methods, business rules
deployment.mdPlatform, env var names, CI/CD triggers, rollback, monitoring

Optional:

  • ux-guidelines.md — only for projects with significant UI
  • {custom}.md — domain-specific

Templates with placeholder structure are in .claude/shared/templates/new-project/.claude/skills/project-knowledge/references/. The templates are self-documenting — each section has comments explaining what to write.

Workflows

1. Audit

Trigger: User asks to audit, check quality, or find bloat.

  1. Read all files from .claude/skills/project-knowledge/references/ + CLAUDE.md + README.md
  2. Flag issues:
    • Code blocks → replace with file references
    • Generic framework knowledge (belongs in official docs) → remove
    • Function-level details → suggest moving to code comments
    • Bloated sections (>3-5KB per file is suspicious) → condense
    • Duplication across files → consolidate to one place
    • Placeholder text ([Project Name], TODO) → fill or remove
    • Inconsistent terminology → standardize
    • Outdated info (files/functions that no longer exist) → update or remove
    • Universal patterns in patterns.md → flag for removal (those belong in code-writing skill)
  3. Preserve operational details: server addresses, SSH configs, deploy commands, log paths, env var names, monitoring URLs. These belong in docs even if they seem "obvious" — they can't be read from code.
  4. Create audit report with issues by file
  5. Ask user which to fix → apply approved changes → verify consistency
Show full SKILL.md (235 more words)Show less
2. Edit

Trigger: User asks to edit or update specific documentation.

  1. Identify target file/section (ask if unclear)
  2. Read current content
  3. Apply changes following documentation principles
  4. Check if changes affect other files (e.g., tech stack mentioned elsewhere) → update related files
3. Check Consistency

Trigger: User asks to verify terminology or check for mismatches.

  1. Read all project-knowledge files
  2. Extract: tech stack names/versions, service names, DB names, env var names, platform names
  3. Find inconsistencies (e.g., "PostgreSQL" vs "Postgres" vs "postgres")
  4. Report → ask user for correct terminology → standardize across all files
4. Show Status

Trigger: User asks about documentation completeness.

  1. Check each file: exists? filled or template? size? last modified?
  2. Classify: filled / partially filled / template / missing
  3. Show status report with recommendations

Root Project Files

CLAUDE.md and README.md are entry points, not documentation. Keep them minimal — they point to project-knowledge, not contain information.

CLAUDE.md (for AI agents): project name, one-line description, reference to project-knowledge skill, backlog path, default branch. Template: .claude/shared/templates/new-project/CLAUDE.md.

README.md (for humans, in Russian): project title, purpose, folder structure overview, link to references/. Template: .claude/shared/templates/new-project/README.md.

When auditing, verify that CLAUDE.md and README.md stay minimal — detailed info belongs in project-knowledge.

Custom Domain Files

Add when project has a significant domain not covered by 4 core files (bot.md, vault.md, trading.md).

Process: create in references/ → update project-knowledge SKILL.md to list it → update CLAUDE.md and README.md if they list doc files.

© radix-ng, 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/documentation-writing of radix-ng/primitives.

Open the folder on GitHubat commit eed2a31

Compare with similar skills

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

Documentation Writing compared with similar skills
SkillStarsUsed inTokensAuto-checkLicenceRepo updated
Documentation Writing this skillradix-ng/primitives274—~1.4kAutomated safety check: PassMIT
Doc Co-Authoring WorkflowshareAI-lab/Kode-CLI5.2k—~977Automated safety check: PassApache-2.0
Program Managerborghei/Claude-Skills881—~1.3kAutomated safety check: PassMIT
Linkedin Announcement Generatordmccreary/ibook-skills105—~5kAutomated safety check: PassCC-BY-NC-4.0
JavaScript Concept Fact Checkerleonardomso/33-js-concepts67k1 repos~5kAutomated safety check: PassMIT
Beads Documentation Style Guidegastownhall/beads28k—~3.2kAutomated safety check: PassMIT

Similar skills

  • Doc Co-Authoring Workflow

    shareAI-lab/Kode-CLI

    Guides a three-stage workflow for turning partial context into a clear PRD, RFC or design doc: capture context, draft section by section, then test with a fresh reader.

    5.2k GitHub stars~977 tokensUpdated 1 mo ago
    Writing & ContentAuto-check passed
  • Program Manager

    borghei/Claude-Skills

    Program management for multi-project coordination, portfolio governance, dependency tracking, benefits realization, charters, and steering-committee reporting.

    881 GitHub stars~1.3k tokensUpdated yesterday
    Writing & ContentAuto-check passed
  • Linkedin Announcement Generator

    dmccreary/ibook-skills

    Generates a LinkedIn post announcing an intelligent textbook milestone by pulling book metrics, chapter count, and key statistics.

    105 GitHub stars~5k tokensUpdated yesterday
    Writing & ContentAuto-check passed
  • JavaScript Concept Fact Checker

    leonardomso/33-js-concepts

    Verifies the technical accuracy of JavaScript concept pages by checking code examples, MDN and ECMAScript claims and external links through a five-phase method.

    67k GitHub starsUsed in 1 repo~5k tokens
    Writing & ContentAuto-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 yesterday
    Writing & ContentAuto-check passed
  • 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.

    67k GitHub stars~3.9k tokensUpdated 28 days ago
    Writing & ContentAuto-check passed

More from radix-ng/primitives

  • Radix Ng

    radix-ng/primitives

    Build correct, accessible UI with @radix-ng/primitives — the signals-first, headless Angular primitive library.

    274 GitHub stars~2.2k tokensUpdated 10 days ago
    Auto-check passed
  • Radix Ng Examples

    radix-ng/primitives

    Index of every documented @radix-ng/primitives example. An agent skill from radix-ng/primitives.

    274 GitHub stars~2.1k tokensUpdated 10 days ago
    Auto-check passed
  • Project Knowledge

    radix-ng/primitives

    A skill your agent uses when you need information about this project's architecture, tech stack, coding patterns, data model, deployment setup, git workflow, or UX guidelines.

    274 GitHub starsUsed in 1 repo~833 tokens
    Auto-check passed
  • Storybook Story

    radix-ng/primitives

    Write or update Storybook stories and docs MDX for a Radix NG primitive following project conventions.

    274 GitHub stars~3.7k tokensUpdated 10 days ago
    Auto-check passed
  • Testing

    radix-ng/primitives

    Test Radix NG primitives across every layer and pick the RIGHT one for a change: Vitest unit (zoneless), jest-axe a11y, Playwright browser regression (apps/visual-regression), SSR…

    274 GitHub stars~3.3k tokensUpdated 10 days ago
    Auto-check passed
  • Angular Developer

    radix-ng/primitives

    Angular framework reference for building this signals-first, headless directive library.

    274 GitHub stars~1.2k tokensUpdated 10 days ago
    Auto-check passed

Questions about Documentation Writing

What does Documentation Writing do?

Maintain project documentation in .claude/skills/project-knowledge/: audit, edit, check consistency, track status. Documentation Writing is an agent skill from radix-ng/primitives.claude/skills/project-knowledge/: audit, edit, check consistency, track status.

When should I use Documentation Writing?

Documentation Writing fits situations like: : проверь документацию; Обнови документацию; Аудит документации; audit documentation.

How do I install Documentation Writing in Claude Code?

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

How do I install Documentation Writing in Codex?

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

Can I use Documentation 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 radix-ng/primitives --skill documentation-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/documentation-writing, .gemini/skills/documentation-writing, .github/skills/documentation-writing and .opencode/skills/documentation-writing in your project.

What does Documentation Writing need to run?

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

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

Documentation Writing 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 Documentation Writing use?

About 1.4k tokens (SKILL.md is roughly 5.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 Documentation Writing?

Skills that share tags, products or a category with Documentation Writing: Doc Co-Authoring Workflow (shareAI-lab/Kode-CLI, 5.2k stars), Program Manager (borghei/Claude-Skills, 881 stars), Linkedin Announcement Generator (dmccreary/ibook-skills, 105 stars) and JavaScript Concept Fact Checker (leonardomso/33-js-concepts, 67k stars). The comparison table on this page puts their stars, adoption, token cost, safety result and licence side by side.

Who maintains Documentation Writing?

radix-ng (a GitHub organization) maintains it in radix-ng/primitives, which has 274 GitHub stars. The repository holds 7 skills in this directory. The repository was last updated on September 28, 2026.

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