documentation-standards

documentation-standards is a skill for Claude Code from Claude-Code-Community-Ireland/claude-code-resources. It costs 34 tokens per session (2,794 once invoked), scanned A, original, MIT.

A guide to writing software documentation, including README files, code comments, API references, changelogs, and technical explanations.

In plain words
What is it for?
Planning README sections, writing quick-start examples, documenting APIs and configuration, and recording changes clearly.
Why use it?
It helps readers understand, install, use, and maintain a project without having to infer its structure from the code.

Skill for Claude Code

Written for Claude Code: shipped in a Claude Code plugin.

Part of the vibeworks-library plugin — 34 skills, 21 commands, 33 agents, 3 hooks shipped together

Good fit Planning README sections, writing quick-start examples, documenting APIs and configuration, and recording changes clearly.

Compare 6 skills from other repositories ↓
Install with agentmods
npx agentmods add skills/claude-code-community-ireland/claude-code-resources/documentation-standards
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.

Any agent
npx skills add Claude-Code-Community-Ireland/claude-code-resources --skill documentation-standards
Clone the repo
git clone --depth 1 https://github.com/Claude-Code-Community-Ireland/claude-code-resources

Made for: Claude Code.

Or install vibeworks-library, the plugin that ships this one along with the rest of its 34 skills, 21 commands, 33 agents, 3 hooks.

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 documentation-standards

README.md
[![agentmods](https://agentmods.dev/badge/skills/claude-code-community-ireland/claude-code-resources/documentation-standards/github.svg)](https://agentmods.dev/skills/claude-code-community-ireland/claude-code-resources/documentation-standards)
Your own site
<a href="https://agentmods.dev/skills/claude-code-community-ireland/claude-code-resources/documentation-standards"><img src="https://agentmods.dev/badge/skills/claude-code-community-ireland/claude-code-resources/documentation-standards/github.svg" alt="Measured on agentmods" height="20"></a>

Or the 80×15 button, for a site that already has a row of RSS and ATOM ones. Only the verdict fits; the numbers stay here.

agentmods 80×15 button for documentation-standards

Your own site · 80×15
<a href="https://agentmods.dev/skills/claude-code-community-ireland/claude-code-resources/documentation-standards"><img src="https://agentmods.dev/badge/skills/claude-code-community-ireland/claude-code-resources/documentation-standards.svg" alt="Reviewed on agentmods" width="80" height="20"></a>
Per session 34 Skills are progressive disclosure: only the name and description are preloaded; the body loads when the skill is used.
When invoked 2,794 The whole file, excluding the scripts and references it only reads on demand.
Security scan A 0 findings. A grade says what 26 rules found in the file — not that it is safe.
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.1 $0.00034 $0.02794
Opus 5.5 $0.00014 $0.01118
Sonnet 5.5 $0.00007 $0.00559
Haiku 4.5 $0.00003 $0.00279

Measured 1mo ago against content hash 2955b0d93ffc, method: parsed. Prices are Anthropic first-party input rates as of 2026-10-07, from the pricing page.

Security

Grade A, and why

documentation-standards 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 1mo 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.

plugins/vibeworks-library/skills/documentation-standards/SKILL.md · 419 lines

How it starts

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

Documentation Standards

README Template

Every project README should follow this structure. Omit sections that genuinely do not apply, but default to including them.

# Project Name

[![Build Status](badge-url)][ci-link]
[![Coverage](badge-url)][coverage-link]
[![npm version](badge-url)][npm-link]
[![License](badge-url)][license-link]

One-paragraph description of what this project does, who it is for,
and why it exists. Lead with the value proposition, not the technology.

## Table of Contents

- [Installation](#installation)
- [Quick Start](#quick-start)
- [Usage](#usage)
- [API Reference](#api-reference)
- [Configuration](#configuration)
- [Contributing](#contributing)
- [License](#license)

## Installation

### Prerequisites

- Node.js >= 18
- PostgreSQL >= 14

### Steps

npm install project-name

## Quick Start

Minimal working example — no more than 10 lines — that gets the
reader from zero to "it works."

## Usage

### Common Use Cases

Organize by task, not by API surface. Show the most common
workflows first.

### Advanced Usage

Edge cases, complex configurations, integration patterns.

## API Reference

Link to generated docs or inline the reference here.

## Configuration

| Variable        | Default   | Description                  |
|-----------------|-----------|------------------------------|
| `PORT`          | `3000`    | Server listening port        |
| `DATABASE_URL`  | —         | PostgreSQL connection string |

## Architecture

Brief overview or link to architecture docs.

## Contributing

See [CONTRIBUTING.md](CONTRIBUTING.md).

## License

[MIT](LICENSE) — see LICENSE file for details.

README Checklist

  • Title matches the package/repo name exactly
  • Description answers "what," "who," and "why" in one paragraph
  • Installation steps are copy-pasteable and tested on a clean machine
  • Quick Start example actually works — verify before merging
  • Badges are live and point to correct URLs
  • All links resolve (no 404s)
  • Configuration table covers every environment variable
  • License is explicitly stated and matches the LICENSE file

Read the full file on GitHub · 419 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. 1mo ago First seen · 419 lines · 34 tokens per session scan A 2955b0d93ffc

Subscribe to this mod's changes

documentation-standards is a skill published in the GitHub repository Claude-Code-Community-Ireland/claude-code-resources (11 stars, last pushed 4mo ago), licensed MIT. It adds 34 tokens to every session and 2,794 once invoked, about $0.0001 per session on Opus 5.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-09-03.

Related

Other skills, from other repositories

orbit-notion

Open Orbit briefing skill — selected by the Orbit pipeline when Notion is the user's only connected connector, or when the user explicitly scopes their daily digest to Notion. Pulls the past 24 hours of document edits, comments, mentions, and database row changes from the user's authenticated Notion connection and…

nexu-io/open-design · 117 tokens

instrument-data-to-allotrope

Convert laboratory instrument output files (PDF, CSV, Excel, TXT) to Allotrope Simple Model (ASM) JSON format or flattened 2D CSV. Use this skill when scientists need to standardize instrument data for LIMS systems, data lakes, or downstream analysis. Supports auto-detection of instrument types. Outputs include full…

anthropics/knowledge-work-plugins · 123 tokens

legal-hold

Issue, refresh, release, or report on legal holds — drafts the hold notice as .docx, updates legalhold fields in log.yaml, and calendars the next refresh. Use when the user says "issue a hold", "refresh hold", "release hold", or asks for a portfolio-wide hold status report.

anthropics/claude-for-legal · 68 tokens

baoyu-youtube-transcript

A tool for downloading the written captions, subtitles, chapter information, speaker labels, and cover image from a YouTube video using its URL or ID.

JimLiu/baoyu-skills · 107 tokens

feishu

Work with Feishu or Lark bots, docs, sheets, bitables, approval flows, and OpenAPI/MCP setup without hardcoding credentials.

Hmbown/CodeWhale · 33 tokens

read

Fetches URLs and PDFs, then summarizes or returns clean Markdown; can also search the web through DeepSeek when built-in search is thin. Use when asked to read, fetch, quote, cite, convert, or save a URL or PDF. Not for local text files already in the repo.

tw93/Waza · 61 tokens