document-feature
Skill16 starsChanged 3 days agoApache-2.0View on GitHub
Create user-facing feature documentation for the docs VitePress docs site. Analyzes the codebase and produces an index.en.md in the correct docs directory. Use when user says 'document this feature', 'write feature docs', 'create docs for X', 'add feature to docs site', or 'user-facing documentation for'. Takes feature name as argument. Do NOT use for ADRs (use /document-decision) or syncing existing docs (use /update-doc).
We split this skill into the rules it gives an agent
6 rules. 0 are common, 3 are distinctive, and 3 are very specific to this project.
0
Common
Most of the 5 edited versions we read keep these.
3
Distinctive
This author's own choices. Worth a look.
3
Very specific
Tied to their project's names, files or tools. Probably skip.
- Common
- Distinctive
- Very specific
- Very specific: line 9
Create user-facing documentation for feature "\$ARGUMENTS" on the Swiss AI Hub VitePress docs site.
- Distinctive: line 14
Read these existing feature docs to understand the tone and structure:
- Very specific: line 26
Search for the feature across scopes (packages/core, packages/agent, packages/api, packages/pipeline, packages/process, packages/web).
- Very specific: line 46
Create index.en.md (NOT index.md) in the new directory.
- Distinctive: line 60
No code blocks that will drift out of sync — reference file paths instead
- Distinctive: line 65
After creating the English file:
“Common” is measured: kept by at least 6 in 10 of the 5 edited versions of this file we could read. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.
Files
Document Feature - Create User-Facing VitePress Documentation
Create user-facing documentation for feature "$ARGUMENTS" on the Swiss AI Hub VitePress docs site. Analyzes the
codebase, then produces an index.en.md file for end users.
Before You Start
Read these existing feature docs to understand the tone and structure:
- MCP:
docs/docs/2_platform/19_mcp/index.en.md— standards-based integration doc with capabilities breakdown - Memory:
docs/docs/2_platform/15_memory/index.en.md— conversational style with "why it matters", "how it works", "two types" sections - Cost Control:
docs/docs/2_platform/14_cost_control/index.en.md— uses::: detailscontainers organically, includes comparison tables
Real docs use natural, conversational section headers — NOT a rigid template. Match the style you see.
Step 1: Research the Feature
Search for the feature across scopes (packages/core, packages/agent, packages/api, packages/pipeline,
packages/process, packages/web). Understand what it does, how users interact with it, and what makes it valuable.
Step 2: Choose the Docs Location
Feature docs live under docs/docs/. Determine where based on audience:
- Platform features (user-facing: UI, chat, admin):
docs/docs/2_platform/{N}_{topic}/index.en.md - SDK features (developer-facing: building agents, pipelines, processes):
docs/docs/3_sdk/6_feature_overview/
Directory naming uses a numeric prefix for sidebar ordering (e.g., 19_mcp/, 15_memory/). Check existing
directories to pick the next available number:
ls -d docs/docs/2_platform/*/
ls -d docs/docs/3_sdk/*/Step 3: Create the Documentation File
Create index.en.md (NOT index.md) in the new directory.
Front matter — only title is required. Ordering comes from the directory prefix, not frontmatter:
---
title: Feature Title
---Writing conventions (from docs/CLAUDE.md):
- User-facing perspective, present tense, jargon-free language
- VitePress containers:
::: info,::: warning,::: details— use organically, not as rigid template - No code blocks that will drift out of sync — reference file paths instead
- Focus on what the feature does for users, not internal architecture
Step 4: Handle Translation
After creating the English file:
- Never create
index.de.mdmanually — it is auto-generated bypnpm run docs:translate - The translation pipeline uses SHA-256 hashes to detect changes (
source_shain.de.mdfrontmatter) - German translations must be committed to git (CI doesn't run translation)
Step 5: Verify
# File exists at the right location
ls docs/docs/2_platform/*_{topic}/index.en.md
# Front matter has title
head -5 docs/docs/2_platform/*_{topic}/index.en.md
# Preview (if dev server is available)
cd docs && pnpm run docs:devCompare your doc with the exemplars from "Before You Start" — it should match their tone and depth.
Troubleshooting
| Problem | Solution |
| Unsure if platform or SDK feature | UI/chat interaction = platform (2_platform/); code/API = SDK (3_sdk/) |
| Feature spans many scopes | Focus on user-visible behavior, not internal architecture |
| Feature not yet fully implemented | Use ::: warning boxes to note incomplete sections |
Don't create docs in 6_code_deep_dive/ | That directory is auto-synced from READMEs via sync-docs.sh |
Done When
index.en.mdcreated in the correctdocs/docs/subdirectory- Front matter has
titlefield - Style matches existing feature docs (MCP, Memory, Cost Control)
- No
index.de.mdcreated manually (translation pipeline handles this)
Other versions5 projects use a version of this.
Word for word · 0
None found.
Edited · 0
None found.
Wrote their own version · 5
- avihaymenahem/velo★ 715same name
- iopsystems/skills-mcp★ 6same name
- martinappberg/chimaera★ 6same name
- orbit-collective/orbit-skills★ 1same name
- WhatIfWeDigDeeper/application-tracker★ 1same name
How matches are found. Word for word: the exact same text. Edited: shares passages with this file (“99% same” means 99% of its five-word phrases also appear here; 10% or more counts). Their own version: similar meaning, or, weakest, the same name. We can’t tell which project had it first. Projects are counted among the 200 most-starred candidates, and mentions are links to the repository we found, up to 50 per site, so both counts are a floor.
In this repository50 other files it gives its agents.
- CLAUDE.mdCLAUDE.md
- docs/CLAUDE.mdCLAUDE.md
- .github/actions/CLAUDE.mdCLAUDE.md
- arc42Skill
- audit-frontendSkill
- bot-frameworkSkill
- create-or-audit-claude-mdSkill
- create-or-audit-skillSkill
- create-or-audit-subagentSkill
- create-prSkill
- dagster-pipelinesSkill
- debug-agentSkill
- debug-frontendSkill
- debug-pipelineSkill
- design-systemSkill
- docker-devSkill
- document-decisionSkill
- explainSkill
- generate-sdkSkill
- i18nSkill
- implement-feedback-from-prSkill
- likec4-dslSkill
- lintSkill
- merge-mainSkill
- nats-eventsSkill
- plan-issueSkill
- pr-demo-videoSkill
- primevue-lookupSkill
- rclone-guideSkill
- reflectSkill
- review-diffSkill
- scaffold-agentSkill
- scaffold-api-endpointSkill
- scaffold-api-repositorySkill
- scaffold-api-serviceSkill
- scaffold-bot-handlerSkill
- scaffold-composableSkill
- scaffold-event-displaySkill
- scaffold-frontend-componentSkill
- scaffold-frontend-pageSkill
- scaffold-frontend-subpageSkill
- scaffold-pipelineSkill
- setup-bot-connectionSkill
- splice-issueSkill
- sync-agent-docsSkill
- test-scopeSkill
- update-docSkill
- verify-sdk-syncSkill
- write-docSkill
- write-issueSkill
Does it work?
Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.
No reviews yet
People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.
- It worked
- Partly
- It didn't
Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.
Your trail
Files you open will collect here, so you can find them again.
Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.
Now do this for your own.
Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.

