documentation
- Repo stars 0
- Author updated Live
- Author repo skills-registry
- Domain
- DevOps
- Compatible agents
-
- Claude Code
- Cursor
- Cline
- Codex
- Windsurf
- Gemini CLI
- +20
- Trust score
- 88 / 100 · community maintained
- Author / version / license
- @tomevault-io · no license declared
- Token usage
- Lean
- Setup complexity
- Plug-and-play
- External API key
- Not required
- Operating systems
- Unspecified (assume cross-platform)
- Runtime requirements
- No special requirements
- Permissions
-
- Read-only
- Write / modify
- Network behavior
- Local-only
- Install commands
- 26 variants
Profile is derived at build time from SKILL.md and install vectors. Subject to drift from author intent.
Heads up: 未限定 allowed-tools,默认拥有全部工具权限。
---
name: documentation
description: </applicability> 文档在docs目录下,根据文档类型进行分类存放,如docs/tasks等。 <!-- tomevault:4.0:skill_md:2026-05-22 --…
category: devops
runtime: no special runtime
---
# documentation output preview
## PART A: Task fit
- Use case: </applicability> 文档在docs目录下,根据文档类型进行分类存放,如docs/tasks等。 <!-- tomevault:4.0:skill_md:2026-05-22 --> runs entirely locally. Works with Claude Code, Cursor, Cline and 23 more..
- Inputs: target material, constraints, expected output, and acceptance criteria.
- Evidence boundary: follow “Decide Fit First / Design Intent / How To Use It” and do not present inference as author intent.
## PART B: Execution result
- **01** The card summarizes the use case; runtime output centers on “</applicability> 文档在docs目录下,根据文档类型进行分类存放,如docs/tasks等。 <!-- tomevault:4.0:skill_md:2026-05-22 --> runs entirely locally. Works with Claude Code, Cursor, Cline and 23 more.”.
- **02** When the source has headings, the agent prioritizes “Decide Fit First / Design Intent / How To Use It” so the result follows the author’s structure.
- **03** Typical output includes task judgment, concrete steps, required commands or file edits, validation, and follow-up options.
- **04** Risk context follows the fingerprint: read files, write/modify files; mostly runs locally; usually needs no extra API key.
## Running Rules
- read files, write/modify files; mostly runs locally; usually needs no extra API key.
- Validate with a small sample before expanding scope.
- Return the result, validation criteria, and next iteration options. The source does not require a stable slash command. After installation, invoke the skill by name and describe the task.
Name target files or source material, expected output, forbidden changes, and whether network or shell access is allowed. Permission fingerprint: read files, write/modify files.
Start with a small task and check whether the result follows “Decide Fit First / Design Intent / How To Use It”. Inspect diffs, logs, previews, or tests before expanding scope.
Confirm the final output includes a concrete result, evidence, and next action. If it stays generic, tighten inputs, boundaries, and acceptance criteria.
---
name: documentation
description: </applicability> 文档在docs目录下,根据文档类型进行分类存放,如docs/tasks等。 <!-- tomevault:4.0:skill_md:2026-05-22 --…
category: devops
source: tomevault-io/skills-registry
---
# documentation
## When to use
- </applicability> 文档在docs目录下,根据文档类型进行分类存放,如docs/tasks等。 <!-- tomevault:4.0:skill_md:2026-05-22 --> 编写markdown文档 创建任务分配有…
- Use it when the task has clear inputs, repeatable steps, and validation criteria.
## What to provide
- Target material, scope, expected result, and forbidden changes.
- Whether network, commands, file writes, or external services are allowed.
## Execution rules
- Organize steps around “Decide Fit First / Design Intent / How To Use It” and keep inference separate from source facts.
- read files, write/modify files; mostly runs locally; usually needs no extra API key.
- Validate with a small sample before expanding the task.
## Output requirements
- Return the deliverable, key evidence, validation method, and next action.
- Mark missing information as unknown; do not invent commands, platforms, or dependencies. The author source anchors workflow facts; repository files anchor sources and commands; Fluxly only adds fit, limitations, and quality judgment.
skill "documentation" {
input -> user goal + target files + boundaries + acceptance criteria
context -> Decide Fit First / Design Intent / How To Use It
rules -> SKILL.md triggers / order / output contract
runtime -> no special runtime | read files, write/modify files | mostly runs locally
guardrails -> usually needs no extra API key + small-sample validation + diff/log review
output -> copyable result + checklist + next iteration
} - 编写markdown文档
- 创建任务分配有追踪文档
- 编写开发指南和部署文档
文档在docs目录下,根据文档类型进行分类存放,如docs/tasks等。
- 使用 markdown 格式编写,遵循 GitHub Flavored Markdown 规范
- 结构清晰,使用标题、列表、表格和代码块组织内容,包括Alert,折叠等。
- 语言简洁明了,避免冗长和复杂句子
- 使用适当的emoji增强可读性
- ❌ 不要编造不存在的功能或 API
- ❌ 不要复制粘贴代码作为文档(应提取关键信息)
- ❌ 不要忽略错误场景的文档(只写成功路径)
- ❌ 不要使用模糊的描述(如"可能"、"或许"、"大概")
Source: AterDev/Perigon.template — distributed by TomeVault.
Decide Fit First
Design Intent
How To Use It
Boundaries And Review