t-doc

t-doc is a skill for Claude Code, Codex from timzaak/web-dev-skills. It costs 84 tokens per session (1,937 once invoked), scanned A, original, Apache-2.0.

A skill that scans a project and writes a beginner-friendly tutorial covering its structure, APIs, configuration, and deployment.

In plain words
What is it for?
Use it to create or update project tutorials, README walkthroughs, and getting-started documentation in the project's existing documentation area.
Why use it?
It turns scattered project details into an onboarding guide that is easier for a new developer to follow.

Skill for Claude CodeCodex

Installs and runs on its own, but its text points at files inside its plugin — anything it tells you to read at a ${CLAUDE_PLUGIN_ROOT} path is only there once the plugin is installed. Installing the plugin gets both.

Part of the t-tools plugin — 28 skills, 31 agents shipped together

Install

Getting it into your agent

One page per mod, every tool's command on it. A separate URL per tool would split the same page into five that compete with each other.

agentmods
npx agentmods add skills/timzaak/web-dev-skills/t-doc
Any agent
npx skills add timzaak/web-dev-skills --skill t-doc
Clone the repo
git clone --depth 1 https://github.com/timzaak/web-dev-skills

Made for: Claude Code, Codex.

Or install t-tools, the plugin that ships this one along with the rest of its 28 skills, 31 agents.

Wrote this? Show the measurements

A badge with what this costs and how it scanned, read live from this page, so it follows the numbers instead of freezing them. Markdown for a README, HTML for a documentation site or a project page.

agentmods badge for t-doc

README.md
[![agentmods](https://agentmods.dev/badge/skills/timzaak/web-dev-skills/t-doc.svg)](https://agentmods.dev/skills/timzaak/web-dev-skills/t-doc)
Your own site
<a href="https://agentmods.dev/skills/timzaak/web-dev-skills/t-doc"><img src="https://agentmods.dev/badge/skills/timzaak/web-dev-skills/t-doc.svg" alt="Measured on agentmods" height="20"></a>
Per session 84 Skills are progressive disclosure: only the name and description are preloaded; the body loads when the skill is used.
When invoked 1,937 The whole file, excluding the scripts and references it only reads on demand.
Security scan A 0 findings. Scan, not verified.
Origin original No closer match found in the catalogue.
Token cost

What it costs to keep this loaded

Counted locally with the o200k_base tokenizer, which is exact for GPT models; Claude uses its own tokenizer and its counts differ. Treat this as one consistent yardstick across the catalogue rather than a bill. Prices are per million input tokens.

ModelPer sessionOnce invoked
Fable 5.1 $0.00084 $0.01937
Opus 5 $0.00042 $0.00968
Sonnet 5 $0.00017 $0.00387
Haiku 4.5 $0.00008 $0.00194

Measured today against content hash 04abc5e96d3a, method: parsed. Prices are Anthropic first-party input rates as of 2026-09-05, from the pricing page.

Security

Grade A, and why

t-doc scanned grade A with 0 findings against 26 rules in 11 categories — prompt injection, anti-refusal, data exfiltration, privilege escalation, supply chain, agent snooping, system-prompt leakage, SSRF and excessive agency — measured today.

A static scan of the body, not an audit. Every finding is printed with the line that produced it so you can judge whether it matters here. A mod is markdown that instructs an agent; that is exactly why what it instructs is worth reading.

Nothing flagged

None of the 26 patterns this scan looks for appear in this file: no shell pipes, no recursive deletes, no credential paths, no hidden text, no instruction-override or anti-refusal phrasing, no agent-config snooping. That is not a guarantee, it is the absence of the things that are checkable.

skills/t-doc/SKILL.md · 144 lines

How it starts

The opening of the file, as written. The whole thing — 144 lines — stays where its author put it; the contents beside it link to each section on GitHub.

写项目教程文档

扫描代码库,提取架构、API、配置、部署等信息,写给新人能读懂的项目教程。文档要像工程师写的,不像自动生成的 API 文档。

使用场景

  • 用户执行 /t-doc [名称]
  • 用户要写项目文档、教程、上手指南、README 教程、onboarding 文档
  • 用户需要面向新人的项目或模块 walkthrough

不要用于 PRD、技术设计、纯 API schema 自动生成,或只改某个文档小段落的任务。

参数和语言

命令格式:

/t-doc [项目或模块名]

名称 必填,1-50 字符,只允许英文、数字、连字符、下划线。不合法就终止,并提示:

请提供合法的名称。例如:/t-doc my-project

输出语言跟随用户输入;用户没明确指定时默认中文。

教程位置判定

写作前先在项目根目录判定教程目标,后续扫描、已有文档检查、写入和验证都使用同一个目标:

  1. 如果存在 docs-web/,优先把教程集成到该文档站点中,不再写入 docs/tutorials/
  2. 读取 docs-web/README.mdpackage.json、站点配置、内容源配置、路由和已有页面,识别真实的内容目录、文件格式、语言结构与导航方式。例如内容可能位于 docs-web/content/docs/,但不要只凭目录名硬编码。
  3. 沿用站点已有约定:使用 .md.mdx,放进现有教程分组或文档内容层级;多语言站点按现有语言目录组织;同步更新 meta.json、sidebar、nav、索引页等导航入口,确保教程能通过 Web 页面访问和发现。
  4. docs-web/ 存在但无法从配置和现有内容确认内容源或路由规则时,列出已识别的候选位置并询问用户,不要静默回退到 docs/tutorials/
  5. 只有项目根目录不存在 docs-web/ 时,才使用 docs/tutorials/ 和下面的 Markdown 默认结构。

目标确定后检查其中是否已有对应教程。若存在,先告诉用户已有内容,询问覆盖还是增量更新。

  • 覆盖:重写目标教程。
  • 增量更新:先读已有文档,只补充或修正变化部分。

信息收集

动笔前先扫描项目。优先看这些来源:

来源 关注点
README.md, CLAUDE.md 项目定位、技术栈、运行方式
package.json, Cargo.toml, pyproject.toml 依赖和版本
src/, app/, lib/ 入口文件 模块结构、路由、核心抽象
docs/, guides/, protocols/ 现有文档和规范
docs-web/ 的配置、内容与导航文件 文档站内容源、格式、语言、路由和导航约定
docker-compose.yml, Dockerfile 部署方式
.github/workflows/, .gitlab-ci.yml, Jenkinsfile CI/CD
.env.example, config/ 配置项
数据库 migration 文件 数据模型

Glob 搜索要避开依赖目录。优先用明确路径,例如 .github/workflows/*.ymlDockerfile、根目录下的 compose 文件;必须用 ** 时,用 path 限定范围,避免扫到 node_modulesvendor.venv

按项目规模选择扫描深度:

  • 小项目(少于 30 个源文件):直接用 Glob 和 Grep 全扫。
  • 中大项目(30-200 个源文件):先读入口文件和 README 建骨架,再按模块深入。
  • 大项目(超过 200 个源文件):先让用户指定覆盖范围,不要一次写完整项目。

扫完先给用户摘要:项目一句话、关键模块、还缺什么信息。连入口文件都找不到时,先问用户再继续。

输出结构

不存在 docs-web/ 时,默认写到:

docs/tutorials/
├── index.md
├── getting-started.md
├── architecture.md
├── api-reference.md
├── configuration.md
└── deployment.md

按项目实际裁剪。没有 API 层就不写 api-reference.md;部署只是 git push 的话,放在 getting-started.md 末尾即可。

Read the full file on GitHub · 144 lines

Files

What ships with it

2 files beside SKILL.md in the same directory: the scripts, references and assets a skill reads on demand. Not counted in the per-session cost; read them before you install if any of them is executable.

Changes

What this file has done since we first saw it

Hashed on every crawl. A supply-chain change to an agent config is a question of when, not whether, so the history is kept rather than the latest state alone.

  1. today Changed · -9 lines · -65 tokens per session 04abc5e96d3a
  2. 5d ago First seen · 153 lines · 149 tokens per session scan A 01f687f01d67

Subscribe to this mod's changes

t-doc is a skill published in the GitHub repository timzaak/web-dev-skills (69 stars, last pushed yesterday), licensed Apache-2.0. It adds 84 tokens to every session and 1,937 once invoked, about $0.0004 per session on Opus 5. A static security scan graded it A with 0 findings. No closer match exists in the catalogue, so it is treated as the original; first seen 2026-08-30.

Related

Other skills, from other repositories

chinese-git-workflow

国内 Git 平台配置参考——Gitee、Coding.net、极狐 GitLab、CNB 的 SSH/HTTPS/凭据/CI 接入差异与镜像同步配置。仅在用户显式 /chinese-git-workflow 时调用,不要根据上下文自动触发。.

jnMetaCode/superpowers-zh · 69 tokens

chinese-commit-conventions

中文 commit 与 changelog 配置参考——Conventional Commits 中文适配、commitlint/husky/commitizen 中文模板、conventional-changelog 中文配置。仅在用户显式 /chinese-commit-conventions 时调用,不要根据上下文自动触发。.

jnMetaCode/superpowers-zh · 65 tokens

chinese-documentation

中文文档排版参考——中英文空格、全半角标点、术语保留、链接格式、中文文案排版指北约定。仅在用户显式 /chinese-documentation 时调用,不要根据上下文自动触发。.

jnMetaCode/superpowers-zh · 62 tokens

chinese-code-review

中文 review 沟通参考——话术模板、分级标注(必须修复/建议修改/仅供参考)、国内团队常见反模式应对。仅在用户显式 /chinese-code-review 时调用,不要根据上下文自动触发。.

jnMetaCode/superpowers-zh · 62 tokens

systematic-debugging

Skill "systematic-debugging" from jnMetaCode/superpowers-zh, covering 系统化调试, 概述, 铁律, 何时使用 and 四个阶段.

jnMetaCode/superpowers-zh · 24 tokens

dispatching-parallel-agents

当面对 2 个以上可以独立进行、无共享状态或顺序依赖的任务时使用.

jnMetaCode/superpowers-zh · 30 tokens