walkeros-writing-documentation

walkeros-writing-documentation is a skill for Claude Code, Codex from elbwalker/walkerOS. It costs 35 tokens per session (5,454 once invoked), scanned A, original, MIT.

A guide for writing walkerOS documentation, including package readmes, website guides, and skills for AI assistants or contributors. It explains how to choose the right document type and verify examples.

In plain words
What is it for?
Use it when creating or updating walkerOS documentation, validating code examples, organizing tutorials and reference material, and documenting new packages or workflows.
Why use it?
It helps documentation stay clear about whether it teaches, explains, gives instructions, or lists reference details. Checking examples reduces the risk of publishing code that does not work.

Skill for Claude CodeCodex

Part of the walkeros plugin — 24 skills shipped together

Install

Getting it into your agent

One page per mod, every tool's command on it. A separate URL per tool would split the same page into five that compete with each other.

agentmods
npx agentmods add skills/elbwalker/walkeros/walkeros-writing-documentation
Any agent
npx skills add elbwalker/walkerOS --skill walkeros-writing-documentation
Clone the repo
git clone --depth 1 https://github.com/elbwalker/walkerOS

Made for: Claude Code, Codex.

Or install walkeros, the plugin that ships this one along with the rest of its 24 skills.

Wrote this? Show the measurements

A badge with what this costs and how it scanned, read live from this page, so it follows the numbers instead of freezing them. Markdown for a README, HTML for a documentation site or a project page.

agentmods badge for walkeros-writing-documentation

README.md
[![agentmods](https://agentmods.dev/badge/skills/elbwalker/walkeros/walkeros-writing-documentation.svg)](https://agentmods.dev/skills/elbwalker/walkeros/walkeros-writing-documentation)
Your own site
<a href="https://agentmods.dev/skills/elbwalker/walkeros/walkeros-writing-documentation"><img src="https://agentmods.dev/badge/skills/elbwalker/walkeros/walkeros-writing-documentation.svg" alt="Measured on agentmods" height="20"></a>
Per session 35 Skills are progressive disclosure: only the name and description are preloaded; the body loads when the skill is used.
When invoked 5,454 The whole file, excluding the scripts and references it only reads on demand.
Security scan A 0 findings. Scan, not verified.
Origin original No closer match found in the catalogue.
Token cost

What it costs to keep this loaded

Counted locally with the o200k_base tokenizer, which is exact for GPT models; Claude uses its own tokenizer and its counts differ. Treat this as one consistent yardstick across the catalogue rather than a bill. Prices are per million input tokens.

ModelPer sessionOnce invoked
Fable 5 $0.00035 $0.05454
Opus 5 $0.00017 $0.02727
Sonnet 5 $0.00007 $0.01091
Haiku 4.5 $0.00003 $0.00545

Measured 4d ago against content hash 7e33720afe39, method: parsed. Prices are Anthropic first-party input rates as of 2026-08-30, from the pricing page.

Security

Grade A, and why

walkeros-writing-documentation scanned grade A with 0 findings against 26 rules in 11 categories — prompt injection, anti-refusal, data exfiltration, privilege escalation, supply chain, agent snooping, system-prompt leakage, SSRF and excessive agency — measured 4d ago.

A static scan of the body, not an audit. Every finding is printed with the line that produced it so you can judge whether it matters here. A mod is markdown that instructs an agent; that is exactly why what it instructs is worth reading.

Nothing flagged

None of the 26 patterns this scan looks for appear in this file: no shell pipes, no recursive deletes, no credential paths, no hidden text, no instruction-override or anti-refusal phrasing, no agent-config snooping. That is not a guarantee, it is the absence of the things that are checkable.

skills/walkeros-writing-documentation/SKILL.md · 669 lines

How it starts

The opening of the file, as written. The whole thing — 669 lines — stays where its author put it; the contents beside it link to each section on GitHub.

Writing Documentation

When to Use This Skill

  • Creating a new package README
  • Writing website documentation (MDX)
  • Creating or updating skills
  • Reviewing documentation for quality
  • Documenting Phase 7 of create-destination or create-source

Prerequisites


Documentation Types

Where Content Belongs

Type Purpose Audience
Package README Installation, basic usage, API reference Package users
Website docs Guides, integration examples, detailed config Integrators
Skills Process knowledge, workflows AI assistants, contributors

Divio Documentation Types

Keep these separate - don't mix tutorials with reference:

Type Purpose User State
Tutorial Learning Studying, beginner
How-To Guide Problem-solving Working, knows what they need
Reference Information lookup Working, needs facts
Explanation Understanding Studying, needs context

Example Validation (CRITICAL)

The Problem

AI-generated examples can be:

  • Syntactically correct but use non-existent APIs
  • Plausible-looking but don't match actual exports
  • Outdated, referencing deprecated patterns

Source of Truth Hierarchy

TIER 1: apps/quickstart/
  ✓ Tested  ✓ Compiled  ✓ CI-validated
  → USE FOR: All code examples

TIER 2: packages/core/src/eventGenerator.ts
  ✓ Canonical events  ✓ Real data structures
  → USE FOR: Event examples

TIER 3: packages/*/src/index.ts exports
  ✓ Actual public API
  → USE FOR: Verifying API names exist

TIER 4: Package READMEs & Website docs
  ⚠ May contain errors
  → VERIFY against Tier 1-3 before trusting

Read the full file on GitHub · 669 lines

Changes

What this file has done since we first saw it

Hashed on every crawl. A supply-chain change to an agent config is a question of when, not whether, so the history is kept rather than the latest state alone.

  1. 4d ago First seen · 669 lines · 35 tokens per session scan A 7e33720afe39

Subscribe to this mod's changes

walkeros-writing-documentation is a skill published in the GitHub repository elbwalker/walkerOS (343 stars, last pushed yesterday), licensed MIT. It adds 35 tokens to every session and 5,454 once invoked, about $0.0002 per session on Opus 5. A static security scan graded it A with 0 findings. No closer match exists in the catalogue, so it is treated as the original; first seen 2026-08-30.

Related

Other skills, from other repositories

coss

Helps implement coss UI components correctly. Use when building UIs with coss primitives (buttons, dialogs, selects, forms, menus, tabs, inputs, toasts, etc.), migrating from shadcn/Radix to coss/Base UI, composing trigger-based overlays, or troubleshooting coss component behavior. Covers imports, accessibility…

usekaneo/kaneo · 80 tokens

build-with-tinybase

Scaffold, extend, and verify reactive local-first JavaScript or TypeScript applications with TinyBase. Use when choosing TinyBase for in-memory tabular or key-value state, generating an app with create-tinybase, adding schemas or UI bindings, configuring browser or database persistence, configuring MergeableStore…

tinyplex/tinybase · 76 tokens

changeset-pr

Create or update a .changeset/.md file for the current branch or PR in this repository, choose the correct package scope and release type, and verify the result against repo-specific Changesets config. Use when a publishable package changed, when a PR is missing a changeset, when an existing changeset needs…

module-federation/core · 88 tokens

gh-pr-metadata

Update the current GitHub PR title and body for this repository so they match the repo's pull request template and conventional-commit title style. Use when a PR title is vague or misformatted, when the PR body is missing required sections or checklist items, when Codex needs to normalize PR metadata before review or…

module-federation/core · 86 tokens

local-ci

Run this repository's local CI parity commands and pnpm run ci:local jobs. Use when validating a change against the same job shapes used in GitHub Actions, choosing the smallest local CI job for a package, workflow, E2E, Metro, devtools, bundle-size, or build-and-test change.

module-federation/core · 68 tokens

frontend-dev-guidelines

Frontend development guidelines for React/TypeScript applications. Modern patterns including Suspense, lazy loading, useSuspenseQuery, file organization with features directory, MUI v7 styling, TanStack Router, performance optimization, and TypeScript best practices. Use when creating components, pages, features…

diet103/claude-code-infrastructure-showcase · 76 tokens