Skip to content
Back to skills

Docs

ASecurity

Documentation and product copy — README, changelog, API docs, UI copy, SEO basics — written from the code as it is, with every command checked. Triggers - "docs", "README", "changelog", "write documentation", "UI copy".

  • 3 stars
  • 0 votes
  • 0 copies
  • 0 views
  • Added October 20, 2026
ai-agentsapisecuritydocumentation

Works with

  • api

Security analysis

A100/100

Scanned October 20, 2026

npx -y skills add laszewskimariusz/brain-ai --skill docs --agent claude-code

Installs into .claude/skills of the current project.

Are you the author of Docs?

Add the live security badge to your README. It updates with every re-scan.

Security grade badge for Docs
[![Security: A — Skills Directory](https://www.skillsdirectory.com/api/skills/laszewskimariusz-docs/badge)](https://www.skillsdirectory.com/skills/laszewskimariusz-docs)

More formats (shields.io, HTML) on the badges page. Keep it an A: scan every change in CI with Pro.

Download with Pro
SKILL.md
---
name: docs
description: Documentation and product copy — README, changelog, API docs, UI copy, SEO basics — written from the code as it is, with every command checked. Triggers - "docs", "README", "changelog", "write documentation", "UI copy".
---
# docs — documentation and copy

## Procedure
1. Settle the audience and language from the project's CLAUDE.md.
2. Read the source of truth (code, `package.json`, scripts, `.env.example`) — documentation describes what exists, not the plan.
3. Write short: sentences under 20 words, active voice, no "innovative" or "revolutionary".
4. Check every command in the document (run it, or mark it as unchecked).

## Patterns
- **README**: what it is (1–2 sentences) → quick start (≤3 copy-paste steps) → stack → environment variables (table: name, required, description — never values) → deploy → licence.
- **Changelog** (Keep a Changelog): `## [x.y.z] — YYYY-MM-DD` with Added / Changed / Fixed / Security.
- **UI copy**: a button is verb + object ("Delete project"); an error says what happened and what to do; an empty state invites an action; loading always has text.
- **SEO**: title under 60 characters with the keyword first, meta description under 160 with a call to action, one H1, descriptive `alt`, Open Graph image 1200×630.

## Rules
- Outdated documentation is worse than none — fix it or delete it.
- No secrets or environment values in examples (`<your-value>`).

Attribution

Is this your skill, or is something wrong with this listing? Request removal or report an issue. Author removals are honored within 72 hours.

Comments

Loading comments…

Newsletter

Get the weekly list of safe new skills, and the ones we pulled.