Agent skill

Document

by spiriMirror in spiriMirror/libuipc

Documentation style guide and rules for creating documentation

Apache-2.0Auto-check passedWriting & Content

Install Document

skills CLI
$ npx skills add spiriMirror/libuipc --skill document -a claude-code

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

GitHub CLI
$ gh skill install spiriMirror/libuipc document --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/spiriMirror/libuipc.git skills-src && mkdir -p .claude/skills && cp -r skills-src/.cursor/skills/document .claude/skills/document && 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
document
GitHub stars
335
Token cost
~930 tokens
SKILL.md length
278 words
Files
1
Skills in repo
16
Repo updated
First seen
Licence
Apache-2.0

At a glance

Documentation style guide and rules for creating documentation

  • Writing & Content work in your project
  • SKILL.md covers Specification Documents…, Tutorial Documents…, Reference Documents… and Build/Install Documents…, plus 2 more sections
  • Reaches cmake.org and github.com

What it does

Document is an agent skill from spiriMirror/libuipc. Documentation style guide and rules for creating documentation

Its SKILL.md is about 930 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 Writing & Content. The repository describes itself as: A Modern Python and C++20 Library of Unified Incremental Potential Contact. The licence is Apache-2.0.

When your agent uses it

  • Writing & Content work in your project

Example prompts

  • “/document”

Requirements

  • Python 3

What it can do on your machine

Read from SKILL.md and the folder at commit 9c748a7. 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

    Hosts in commands or code, which the agent is likely to contact:

    • cmake.org
    • github.com

    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

Document loads about 930 tokens when it runs. Until then it costs about 18 tokens; SKILL.md has 278 words of instructions outside code blocks.

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

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 spiriMirror/libuipc at commit 9c748a7, republished under its Apache-2.0 licence (© spiriMirror). 278 words, ~930 tokens.

Download SKILL.mdSave it as .claude/skills/document/SKILL.md (or your agent's skills folder).
name
document
description
Documentation style guide and rules for creating documentation

Document Rules

Documentation style varies by type. Follow these principles for consistency.

Specification Documents (docs/specification/)

Purpose: Formal mathematical reference for constitutions, geometries, and core concepts.

Rules:

  • Use LaTeX math ($$ for display, $ for inline) extensively
  • Define all variables after formulas
  • Prefer math over code examples
  • Structure: Definition → State Variables → Formulations → Energy Functions
  • Use numbered sections: ## #12 Hookean Spring
  • Reference academic papers when applicable
  • Include parameter ranges: "$100MPa \le \kappa \le 100GPa$"
  • Explain notation: "where $|\cdot|_F$ is the Frobenius norm"
  • Cross-reference: [link text](./file.md)
  • Include diagrams (SVG): ![Description](./media/figure.svg)

Example:

markdown
# Hookean Spring

**Hookean Spring** is a constitutive model for simulating linear elastic springs.

## #12 Hookean Spring

$$
E = \frac{\kappa}{2} \epsilon^2 = \frac{\kappa}{2} \left(\frac{L - L_0}{L_0}\right)^2
$$

where:
- $\kappa$ is the spring constant
- $L_0$ is the rest length

Tutorial Documents (docs/tutorial/)

Purpose: User-friendly guides with code examples.

Rules:

  • Always provide both C++ and Python using tabs:
    markdown
    === "C++"
        \`\`\`cpp
        // code
        \`\`\`
    === "Python"
        \`\`\`python
        # code
        \`\`\`
  • Include complete, runnable examples with imports
  • Start high-level, progress to details
  • Use diagrams: ![description](./media/file.svg)
  • Include step-by-step workflows
  • Use tables for structured data

Example:

markdown
=== "C++"
    \`\`\`cpp
    using namespace uipc::core;
    Scene scene;
    \`\`\`
=== "Python"
    \`\`\`python
    from uipc.core import *
    scene = Scene()
    \`\`\`

Reference Documents (docs/specification/*_uid.md)

Purpose: Technical reference for identifiers and ranges.

Rules:

  • Define identifier ranges clearly
  • Distinguish official vs. user-defined ranges
  • List all official identifiers
  • Cross-reference to detailed specs

Example:

markdown
# Constitution UID

64-bit unsigned integer. Official range: $[0, 2^{32}-1]$. User-defined: $[2^{32}, 2^{64}-1]$.

Build/Install Documents (docs/build_install/)

Purpose: Step-by-step build instructions.

Rules:

  • Use prerequisites table with versions and links
  • Number steps clearly
  • Include verification commands
  • Use shell tags: shell, bash, powershell
  • Show copy-pasteable commands

Example:

markdown
| Name | Version | Usage | Import |
|------|---------|-------|--------|
| [CMake](https://cmake.org/) | >=3.26 | build system | system install |

\`\`\`shell
git clone https://github.com/microsoft/vcpkg.git
\`\`\`

General Rules

  • Math: $$ for display, $ for inline. Define variables after formulas. Use bold for vectors: $\mathbf{x}$
  • Code: Appropriate language tags. Complete, runnable examples. C++/Python tabs in tutorials
  • Links: Relative paths [text](./file.md). Link to related docs and external resources
  • Media: Store in media/ subdirectories. Use SVG. Reference: ![Description](./media/file.svg)
  • Tables: Markdown tables with headers for structured data
  • Headers: # title, ## sections, ### subsections

Checklist

  • Formulas use LaTeX, variables defined
  • Code examples complete and runnable
  • Cross-references use relative paths
  • Images exist and are referenced
  • Tables formatted correctly
  • Document type principles followed
  • No ambiguity in technical descriptions

© spiriMirror, 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 .cursor/skills/document of spiriMirror/libuipc.

Open the folder on GitHubat commit 9c748a7

Compare with similar skills

Document 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.

Document compared with similar skills
SkillStarsUsed inTokensAuto-checkLicenceRepo updated
Document this skillspiriMirror/libuipc335—~930Automated safety check: PassApache-2.0
HumanizerAzure-Samples/interview-coach-agent-framework17237 repos~5.8kAutomated safety check: PassMIT
Avoid AI Writingconorbronsdon/avoid-ai-writing4.9k3 repos~8.1kAutomated safety check: PassMIT
JavaScript Concept Fact Checkerleonardomso/33-js-concepts67k1 repos~5kAutomated safety check: PassMIT
User-Facing Text Cleanupguillaumemeyer/watermarks-remover23k—~3.5kAutomated safety check: PassMIT
Install Anti Sloptrycompai/crm11k1 repos~881Automated safety check: PassMIT

Similar skills

  • Humanizer

    Azure-Samples/interview-coach-agent-framework

    Official

    Remove signs of AI-generated writing from text. An agent skill from Azure-Samples/interview-coach-agent-framework.

    172 GitHub starsUsed in 37 repos~5.8k tokens
    Writing & ContentAuto-check passed
  • Avoid AI Writing

    conorbronsdon/avoid-ai-writing

    Audit and rewrite content to remove AI writing patterns ("AI-isms").

    4.9k GitHub starsUsed in 3 repos~8.1k tokens
    Writing & ContentAuto-check passed
  • JavaScript Concept Fact Checker

    leonardomso/33-js-concepts

    Verifies the technical accuracy of JavaScript concept pages by checking code examples, MDN and ECMAScript claims and external links through a five-phase method.

    67k GitHub starsUsed in 1 repo~5k tokens
    Writing & ContentAuto-check passed
  • User-Facing Text Cleanup

    guillaumemeyer/watermarks-remover

    Audits prose for invisible Unicode characters and rewrites it while keeping facts, citations, code and required disclosures unchanged and the writer's voice intact.

    23k GitHub stars~3.5k tokensUpdated yesterday
    Writing & ContentAuto-check passed
  • Install Anti Slop

    trycompai/crm

    Install and configure the anti-slop Oxlint plugin in a local TypeScript or JavaScript repository.

    11k GitHub starsUsed in 1 repo~881 tokens
    Writing & ContentAuto-check passed
  • Social Content

    freekmurze/dotfiles

    When the user wants help creating, scheduling, or optimizing social media content for LinkedIn, Twitter/X, Instagram, TikTok, Facebook, or other platforms.

    1k GitHub starsUsed in 22 repos~2.1k tokens
    Writing & ContentAuto-check passed

More from spiriMirror/libuipc

All 16 skills in this repo
  • GPU Optimization

    spiriMirror/libuipc

    GPU optimization workflow using uipc.profile, uipc.profile.nsight, and Nsight Compute CLI.

    335 GitHub stars~3.6k tokensUpdated 4 days ago
    Auto-check passed
  • Review PR

    spiriMirror/libuipc

    Review a libuipc pull request end-to-end: checkout the PR, summarize changes, list files for the human reviewer, and perform a domain-aware AI review covering physics correctness, backend…

    335 GitHub stars~1.7k tokensUpdated 4 days ago
    Auto-check passed
  • Xmake Workflow

    spiriMirror/libuipc

    Build and test the libuipc project using XMake. An agent skill from spiriMirror/libuipc.

    335 GitHub stars~588 tokensUpdated 4 days ago
    Auto-check passed
  • Cmake Workflow

    spiriMirror/libuipc

    Build and test the libuipc project using CMake. An agent skill from spiriMirror/libuipc.

    335 GitHub stars~321 tokensUpdated 4 days ago
    Auto-check passed
  • Fix Issue

    spiriMirror/libuipc

    Fix a GitHub issue with proper branch, testing, and PR workflow

    335 GitHub stars~421 tokensUpdated 4 days ago
    Auto-check passed
  • Fix PR

    spiriMirror/libuipc

    Fix a pull request based on review feedback. An agent skill from spiriMirror/libuipc.

    335 GitHub stars~448 tokensUpdated 4 days ago
    Auto-check passed

Questions about Document

What does Document do?

Documentation style guide and rules for creating documentation. Document is an agent skill from spiriMirror/libuipc.

When should I use Document?

Document fits situations like: writing & Content work in your project.

How do I install Document in Claude Code?

Run `npx skills add spiriMirror/libuipc --skill document -a claude-code`. Or copy the skill folder (.cursor/skills/document in spiriMirror/libuipc) into .claude/skills/document in your project. Claude Code loads it when a task matches its description.

How do I install Document in Codex?

Run `npx skills add spiriMirror/libuipc --skill document -a codex`. Or copy the skill folder (.cursor/skills/document in spiriMirror/libuipc) into .agents/skills/document in your project. Codex loads it when a task matches its description.

Can I use Document 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 spiriMirror/libuipc --skill document -a cursor` (or -a gemini-cli, github-copilot or opencode for the others). To copy it by hand, put the folder in .cursor/skills/document, .gemini/skills/document, .github/skills/document and .opencode/skills/document in your project.

What does Document need to run?

SKILL.md names no scripts, command-line tools or credentials: Document is instructions for the agent only. Our summary lists: Python 3.

Does Document access the network?

SKILL.md names 2 domains. In commands or code: cmake.org and github.com; the agent is likely to contact these when it follows the instructions. This is read from the text; nothing was executed.

Is Document 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 Document use?

Document 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 Document use?

About 930 tokens (SKILL.md is roughly 3.7k 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 Document?

Skills that share tags, products or a category with Document: Humanizer (Azure-Samples/interview-coach-agent-framework, 172 stars), Avoid AI Writing (conorbronsdon/avoid-ai-writing, 4.9k stars), JavaScript Concept Fact Checker (leonardomso/33-js-concepts, 67k stars) and User-Facing Text Cleanup (guillaumemeyer/watermarks-remover, 23k stars). The comparison table on this page puts their stars, adoption, token cost, safety result and licence side by side.

Who maintains Document?

spiriMirror (a GitHub organization) maintains it in spiriMirror/libuipc, which has 335 GitHub stars. The repository holds 16 skills in this directory. The repository was last updated on October 3, 2026.

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