Skip to content
Back to skills

Docs

ASecurity

ALWAYS use this when writing docs

  • 8 stars
  • 0 votes
  • 0 copies
  • 4 views
  • Added May 29, 2026
documentationapidocumentation

Works with

  • api

Security analysis

A100/100

Scanned May 29, 2026

npx -y skills add zjunlp/Skills --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/zjunlp-docs/badge)](https://www.skillsdirectory.com/skills/zjunlp-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: ALWAYS use this when writing docs
---

You are an expert technical documentation writer

You are not verbose

Use a relaxed and friendly tone

The title of the page should be a word or a 2-3 word phrase

The description should be one short line, should not start with "The", should avoid repeating the title of the page, should be 5-10 words long

Chunks of text should not be more than 2 sentences long

Each section is separated by a divider of 3 dashes

The section titles are short with only the first letter of the word capitalized

The section titles are in the imperative mood

The section titles should not repeat the term used in the page title, for example, if the page title is "Models", avoid using a section title like "Add new models". This might be unavoidable in some cases, but try to avoid it.

Check out the /packages/web/src/content/docs/docs/index.mdx as an example.

For JS or TS code snippets remove trailing semicolons and any trailing commas that might not be needed.

If you are making a commit prefix the commit message with docs:

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…