Skip to content
Skills Library
Programming · Writing

docs

/docs

Write and maintain project documentation under docs/generated/ — /docs write creates or updates a doc on a topic, /docs check reports stale content, broken code references, and orphan files. Use when the user wants to capture the design intent behind a feature, record an architectural decision, or verify existing docs still match the code. Docs use [symbol](file-path) reference pointers instead of inline code blocks.

Licence
MIT
Last repository change
04.08.2026

Assessment and security

100/ 100Class: good
Format25 / 25
Frontmatter with name and description, valid name, description up to 1,024 characters, name matching the folder.
Discoverability25 / 25
Description explains when to use the skill, has a reasonable length and uses third person.
Content35 / 35
At least 150 words and at most 500 lines, headings, step lists, examples or code.
Hygiene15 / 15
No placeholders such as TODO, no Windows paths, with a licence.
Riskno signals detected in the scan
Files in this package
6
Scripts
0
HTML comments
0
URLs in SKILL.md
0
Deprecation

No signals detected. Repository changed on 04.08.2026, without references to retired models or APIs.

Licence

MIT, open: use and modify while retaining author attribution.

What it does and when to use it

Write and maintain project documentation under docs/generated/ — /docs write creates or updates a doc on a topic, /docs check reports stale content, broken code references, and orphan files. Use when the user wants to capture the design intent behind a feature, record an architectural decision, or verify existing docs still match the code. Docs use [symbol](file-path) reference pointers instead of inline code blocks.

Arguments

/docs <write|check> [topic] [code-path]
Original author description

Write and maintain project documentation under docs/generated/ — /docs write creates or updates a doc on a topic, /docs check reports stale content, broken code references, and orphan files. Use when the user wants to capture the design intent behind a feature, record an architectural decision, or verify existing docs still match the code. Docs use [symbol](file-path) reference pointers instead of inline code blocks.

How it works

  1. Input
  2. Instructions
Original SKILL.md headings · 83 lines, 403 words
SKILL.md preview
---
name: docs
version: 0.0.3
category: productivity
description: "Write and maintain project documentation under docs/generated/ — /docs write creates or updates a doc on a topic, /docs check reports stale content, broken code references, and orphan files. Use when the user wants to capture the design intent behind a feature, record an architectural decision, or verify existing docs still match the code. Docs use [symbol](file-path) reference pointers instead of inline code blocks."
argument-hint: "<write|check> [topic] [code-path]"
---

# Docs

## Input

```text
$ARGUMENTS
```

## Instructions

### Document Root

Documents managed by this skill are stored under `docs/generated/`.
They are organized by category subdirectories: `docs/generated/<category>/<slug>.md`

Documents outside `docs/generated/` are considered manually written and must never be modified.

### Tool Usage Rules

Always use the tools below for document search and management. Do not open files one by one — search with patterns.

| Purpose | Tool | Usage |
|---------|------|-------|
| Find document files | **Glob** | `docs/generated/**/*.md` pattern to get full document list |
| Search frontmatter | **Grep** | Filter by `title:`, `category:` patterns |
| Read existing docs | **Read** | Read frontmatter + body (only necessary documents) |
| Verify code references | **Glob** | Check if file paths in `code_refs` exist |
| Create documents | **Write** | Create new document files |
| Update documents | **Edit** | Update specific parts of existing documents |
| Scan INDEX | **Read** | Read `docs/generated/INDEX.md` for category structure and document list |

### Subcommand Routing

The first word of `$ARGUMENTS` determines the subcommand.

| First word | Action |
|------------|--------|
| `write` | Read and execute `references/write-procedure.md` |
| `check` | Read and execute `references/check-procedure.md` |
| (none / help) | Print usage below and stop |

**When run without a subcommand:**

```
## docs

Writes and maintains project documentation under `docs/generated/`.

### Commands

| Command | Description |
|---------|-------------|
| write <topic> [code-path] | Write or update a document on the topic |
| check | Check all document status (stale, broken refs, orphan docs) |

### Features

- Uses `[symbol](file-path)` reference pointers instead of code blocks
- Organized by category folders under `docs/generated/`
- INDEX.md based document indexing
```

### Argument Parsing

Parse the remaining arguments after removing the subcommand keyword (`write` / `check`).

**`write` arguments:**
- First argument: **topic** (required) — title/topic of the document
- Second argument: **code-path** (optional) — path to related code (file or directory)

Examples:
- `/docs write "auth flow design"` → topic only
- `/docs write "auth flow" src/auth/` → topic + code-path

**`check` arguments:** None.

### Document Writing Principles

1. **Minimize code blocks**: Do not include code snippets directly in documents. Instead, use markdown links in the form `[symbol](project-root-relative/file-path)` as references.
2. **Focus on design intent**: Record "why it was done this way" rather than "what was done".
3. **Protect manual documents**: Never modify documents outside `docs/generated/`.
Files in this package (6)
  • README.ko.md 3 KB
  • README.md 2 KB
  • SKILL.md 3 KB
  • references/check-procedure.md 2 KB
  • references/frontmatter-template.md 2 KB
  • references/write-procedure.md 4 KB

Versions

RepositoryScoreLicence
This page · 2ykwang/agent-skills100MIT
tanstack/ai100MIT
mthines/agent-skills100MIT
lilly-logic-labs/lll-skills100MIT
kriscard/kriscard-claude-plugins100MIT
imgly/agent-skills100MIT
kriscard/Skills100MIT
The01Geek/prflow100MIT
grimoire-rs/grimoire100Apache-2.0

Identical content appears in 1 other GitHub folders. We show one copy with the highest score.

Database snapshot: 13.11.2026 · package version e8784c71bc71 (SHA-256 digest of the entire package)

Downloads in the last 30 days: 0 · ranking

Report a problem with this skill: harmful content, incorrect descriptions or an author’s removal request.

Similar skills

  • 100docs-check
    Read-only audit of documentation against the current codebase, flags stale docs, missing sections, broken links, and hallucinated claims (wrong file references, wrong counts, diagram entities that don't exist in code). Use for "check the docs", "audit documentation", "are the…
  • 100doc-gardening
    Cross-check docs/ against current code — flag stale file paths, broken cross-references, removed APIs, and outdated examples. Use when docs may have drifted after code changes. For doc completeness and quality use /documentation-audit instead.
  • 100doc-freshness
    Detect documentation drift, stale references, and cross-document inconsistencies in any project. Scans for code-doc drift (API/function changes not reflected in docs), cross-doc drift (conflicting information across documents), and stale references (broken links, deleted files,…
  • 100project-docs
    Generate project documentation from codebase analysis — ARCHITECTURE.md, API_ENDPOINTS.md, DATABASE_SCHEMA.md. Reads source code, schema files, routes, and config to produce accurate, structured docs. Use when starting a project, onboarding contributors, or when docs are missing…
  • 100docs-audit
    Audit docs/ design documents, specs, and implementation plans against current source code for drift. Outputs a drift report and updates documents. Triggers on "check if docs are up to date", "diff docs vs code", "update design docs", "docs consistency check", "verify specs match…
  • 98review-docs
    Review agentic documentation by verifying local claims against source code and cross-repository claims against available authoritative resources. Use when checking generated or existing agent docs for factual accuracy, stale claims, broken references, or pre-PR readiness.

Feedback and reports

Your message goes to Bartosz Sokoliński. An email address is needed only for a reply. See the privacy policy.