Agent skill

Xlings Docs Writing

by openxlings in openxlings/xlings

xlings 项目文档编写规范 — 面向人的 docs/ 目录文档应遵循的风格、格式和组织约定。Use when creating or modifying documents in the docs/ directory.

Apache-2.0Auto-check passedDevelopment

Install Xlings Docs Writing

skills CLI
$ npx skills add openxlings/xlings --skill xlings-docs-writing -a claude-code

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

GitHub CLI
$ gh skill install openxlings/xlings xlings-docs-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/openxlings/xlings.git skills-src && mkdir -p .claude/skills && cp -r skills-src/.agents/skills/xlings-docs-writing .claude/skills/xlings-docs-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
xlings-docs-writing
GitHub stars
615
Token cost
~367 tokens
SKILL.md length
90 words
Files
1
Skills in repo
2
Repo updated
First seen
Licence
Apache-2.0

At a glance

xlings 项目文档编写规范 — 面向人的 docs/ 目录文档应遵循的风格、格式和组织约定。Use when creating or modifying documents in the docs/ directory.

  • Works in 4 steps: 开头:一段话概述项目(无标题前缀) → "快速了解"表格:核心概念速查 → 分章节目录:一、架构 → 二、设计 → 三、规范 → 四、指南 → …
  • Modifying documents in the docs/ directory
  • SKILL.md covers 适用范围, 语言风格, 文档结构 and 图表, plus 4 more sections
  • Instructions only: no scripts, shell commands, URLs or credentials in SKILL.md

What it does

Xlings Docs Writing is an agent skill from openxlings/xlings. xlings 项目文档编写规范 — 面向人的 docs/ 目录文档应遵循的风格、格式和组织约定。Use when creating or modifying documents in the docs/ directory.

Its SKILL.md is about 370 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 Development. The repository describes itself as: Universal package infrastructure with OS-like SubOS isolation - Multi-version · Rootless · Decentralized Index · Agent-ready. The licence is Apache-2.0.

When your agent uses it

  • Modifying documents in the docs/ directory

Example prompts

  • “Use the xlings-docs-writing skill to xling 项目文档编写规范 — 面向人的 docs/ 目录文档应遵循的风格、格式和组织约定。Use when creating or modifying documents in the docs/ directory”
  • “/xlings-docs-writing”

Workflow steps

4 steps, taken from the first numbered list in SKILL.md.

  1. 开头:一段话概述项目(无标题前缀)
  2. "快速了解"表格:核心概念速查
  3. 分章节目录:一、架构 → 二、设计 → 三、规范 → 四、指南
  4. 不包含编写约定、agent 指令等元信息

What it can do on your machine

Read from SKILL.md and the folder at commit c1d271d. 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 (its code samples are markdown).

    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

Xlings Docs Writing loads about 367 tokens when it runs. Until then it costs about 33 tokens; SKILL.md has 90 words of instructions outside code blocks.

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

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 openxlings/xlings at commit c1d271d, republished under its Apache-2.0 licence (© openxlings). 90 words, ~367 tokens.

Download SKILL.mdSave it as .claude/skills/xlings-docs-writing/SKILL.md (or your agent's skills folder).
name
xlings-docs-writing
description
xlings 项目文档编写规范 — 面向人的 docs/ 目录文档应遵循的风格、格式和组织约定。Use when creating or modifying documents in the docs/ directory.

xlings 文档编写规范

适用范围

docs/ 目录下的所有文档。此规范不适用于 .agents/docs/(agent 工作区,格式自由)。

语言风格

  • 使用中文
  • 简洁的陈述性语句,学术/技术文档风格
  • 不使用口语化表达、网络用语、推广性语句
  • 不使用语气词("吧"、"呢"、"啊")
  • 不使用 emoji(除 README.md 以外)
  • 不添加面向 agent 的指令或元信息(如"约定"、"规则"段落)

文档结构

每份文档必须包含:

markdown
# 标题

> 编写日期: YYYY-MM-DD | 版本: X.Y.Z

## 第一节
...
  • 标题用一级标题 #
  • 紧跟日期和版本标识(blockquote 格式)
  • 正文从二级标题 ## 开始

图表

  • 所有图表使用 Mermaid 语法(GitHub 原生渲染)
  • 支持的图表类型:graph、sequenceDiagram、flowchart、classDiagram
  • 不使用 ASCII art

目录组织

docs/
├── README.md              文档索引(含快速了解 + 分章节目录)
├── architecture/          系统级全景
├── design/                子系统设计决策
├── spec/                  接口契约(版本化)
└── guide/                 面向使用者的操作指南
各层内容定位
层回答什么问题读者
architecture"系统整体是什么样的"初次了解项目的人
design"为什么这样设计"需要修改/扩展功能的开发者
spec"接口契约是什么"包作者、Agent 集成者
guide"怎么操作"终端用户

docs/README.md 格式

  1. 开头:一段话概述项目(无标题前缀)
  2. "快速了解"表格:核心概念速查
  3. 分章节目录:一、架构 → 二、设计 → 三、规范 → 四、指南
  4. 不包含编写约定、agent 指令等元信息

文件命名

  • 使用 kebab-case:subos-as-xpkg.md、xvm-version-management.md
  • 不加日期前缀(日期在文档内部标注)
  • 文件名应能独立表达内容主题

注意事项

  • docs/ 目录面向人类读者,不放 agent 工作草稿
  • agent 工作草稿放 .agents/docs/(命名格式 YYYY-MM-DD-xxx.md)
  • 设计文档从 .agents/docs/ 定稿后升级到 docs/design/
  • 已规划但未编写的文档在 README.md 中用 (待补充) 标注

© openxlings, Apache-2.0. 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 .agents/skills/xlings-docs-writing of openxlings/xlings.

Open the folder on GitHubat commit c1d271d

Compare with similar skills

Xlings Docs 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.

Xlings Docs Writing compared with similar skills
SkillStarsUsed inTokensAuto-checkLicenceRepo updated
Xlings Docs Writing this skillopenxlings/xlings615—~367Automated safety check: PassApache-2.0
Vercel Composition Patternssupabase/supabase111k58 repos~726Automated safety check: PassMIT
Finishing a Development Branchobra/superpowers297k5 repos~1.9kAutomated safety check: PassMIT
Typescript Advanced Typesrolling-scopes/rsschool-app10k25 repos~4.2kAutomated safety check: PassMPL-2.0
PR Babysitteropeninterpreter/openinterpreter69k3 repos~4.2kAutomated safety check: PassApache-2.0
Code Review ChecklistshareAI-lab/learn-claude-code78k5 repos~1.1kAutomated safety check: PassMIT

Similar skills

  • Official

    React composition patterns that scale. An agent skill from supabase/supabase.

    111k GitHub starsUsed in 58 repos~726 tokens
    DevelopmentAuto-check passed
  • Walks the last step of a branch: confirm tests pass, detect the git environment, ask how to integrate, carry out your choice and clean up the worktree.

    297k GitHub starsUsed in 5 repos~1.9k tokens
    DevelopmentAuto-check passed
  • Typescript Advanced Types

    rolling-scopes/rsschool-app

    Master TypeScript's advanced type system including generics, conditional types, mapped types, template literals, and utility types for building type-safe applications.

    10k GitHub starsUsed in 25 repos~4.2k tokens
    DevelopmentAuto-check passed
  • PR Babysitter

    openinterpreter/openinterpreter

    Watches an open GitHub pull request until it merges, handling review comments, diagnosing CI failures and retrying flaky checks along the way.

    69k GitHub starsUsed in 3 repos~4.2k tokens
    DevelopmentAuto-check passed
  • Code Review Checklist

    shareAI-lab/learn-claude-code

    Reviews code against a five-part checklist covering security, correctness, performance, maintainability and testing, and reports findings in a fixed format.

    78k GitHub starsUsed in 5 repos~1.1k tokens
    DevelopmentAuto-check passed
  • Greploop

    onyx-dot-app/onyx

    Iteratively improves a PR (GitHub), MR (GitLab), or shelved changelist (Perforce) until Greptile gives it a 5/5 confidence score with zero unresolved comments.

    32k GitHub starsUsed in 4 repos~3.3k tokens
    DevelopmentAuto-check passed

More from openxlings/xlings

  • System Design

    openxlings/xlings

    Design systems, services, and architectures. An agent skill from openxlings/xlings.

    615 GitHub starsUsed in 1 repo~328 tokens
    Auto-check passed

Categories

Questions about Xlings Docs Writing

What does Xlings Docs Writing do?

xlings 项目文档编写规范 — 面向人的 docs/ 目录文档应遵循的风格、格式和组织约定。Use when creating or modifying documents in the docs/ directory. Xlings Docs Writing is an agent skill from openxlings/xlings. xlings 项目文档编写规范 — 面向人的 docs/ 目录文档应遵循的风格、格式和组织约定。Use when creating or modifying documents in the docs/ directory.

When should I use Xlings Docs Writing?

Xlings Docs Writing fits situations like: modifying documents in the docs/ directory.

How do I install Xlings Docs Writing in Claude Code?

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

How do I install Xlings Docs Writing in Codex?

Run `npx skills add openxlings/xlings --skill xlings-docs-writing -a codex`. Or copy the skill folder (.agents/skills/xlings-docs-writing in openxlings/xlings) into .agents/skills/xlings-docs-writing in your project. Codex loads it when a task matches its description.

Can I use Xlings Docs 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 openxlings/xlings --skill xlings-docs-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/xlings-docs-writing, .gemini/skills/xlings-docs-writing, .github/skills/xlings-docs-writing and .opencode/skills/xlings-docs-writing in your project.

What does Xlings Docs Writing need to run?

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

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

Xlings Docs Writing is published under the Apache-2.0 licence (the repository's licence). It allows redistribution, so the full SKILL.md is shown on this page.

How many tokens does Xlings Docs Writing use?

About 367 tokens (SKILL.md is roughly 1.5k 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 Xlings Docs Writing?

Skills that share tags, products or a category with Xlings Docs Writing: Vercel Composition Patterns (supabase/supabase, 111k stars), Finishing a Development Branch (obra/superpowers, 297k stars), Typescript Advanced Types (rolling-scopes/rsschool-app, 10k stars) and PR Babysitter (openinterpreter/openinterpreter, 69k stars). The comparison table on this page puts their stars, adoption, token cost, safety result and licence side by side.

Who maintains Xlings Docs Writing?

openxlings (a GitHub organization) maintains it in openxlings/xlings, which has 615 GitHub stars. The repository holds 2 skills in this directory. The repository was last updated on October 9, 2026.

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