Home / devcodex-labs / devcodex · GitHub

dev-docs SKILL.md skillA

dev-docs from devcodex-labs/devcodex is an agent skill: a SKILL.md folder an AI agent loads when a task calls for it.

Install it, pinned

mdr add devcodex-labs/devcodex/dev-docs@git:20260908.6caf1bf

Pins git:20260908.6caf1bf in mdr.lock. Pin the fingerprint instead.

Audit grade: A, 17 of 17 checks passed
Kind: SKILL.md skill
Repository: devcodex-labs/devcodex
Path: content/skills/dev-docs/SKILL.md
Versions recorded: 2
Latest version: git:20260908.6caf1bf, committed Sep 8, 2026
First version recorded: Jul 30, 2026
Size: 9,470 bytes
Repository stars: 432
License: AGPL-3.0

文档开发子类型规范 — 技术文档/API文档/README 编写规范.

Collected from public GitHub. Every version is saved exactly as it was and never changes. Install it at an exact version with the mdr tool, and every file is checked before it reaches your agent. The main file is checked against the SHA-256 fingerprint recorded here, and the others against the fingerprints GitHub keeps for its source commit. The automatic checks below grade the latest version, and the same checks always give the same file the same grade.

What the file says

# Dev Docs Skill

## 触发条件

用户要求编写/更新**技术类**文档：API/契约说明、架构文档、开发指南、迁移**实现**说明、通用技术 Markdown 等。

> ⛔ **入口分流（DocsAudienceIntent，强制）**  
> 写文档任务由模型依据用户目的与预期读者判定 `docsAudience` + `docsSurface`；`scripts/lib/docs-audience-intent.js` 只校验结构化决策，不依据关键词选择：  
> - `public-user`（用户使用站 / README / 用户手册 / 用户向 changelog·operations·reference）→ **必须 handoff** `user-manual-authoring`（+ 条件 `readme-authoring`），**不得**以本 Skill 为主写作入口。  
> - `maintainer-dev`（维护者开发站 / contributing / 发版 runbook / ADR 站）→ **必须 handoff** `maintainer-docs-site-authoring`。  
> - `ambiguous` → 先补上下文，确实影响交付时再消歧；`multi-audience` → 按读者组织交付物，保留已确认任务范围。  
> - 仅当受众已是技术读者且 surface 为契约/架构/通用技术文时，本 Skill 才作为主入口（light-api / frontend-api / general-doc）。

## 豁免项

- 豁免 `plan-review`（**业务文档内容**任务不需要实施计划审查）
- 豁免 `impact-review`（文档变更不涉及代码影响评估）
- 豁免 CP3（**仅** `dev.docs` 子类型写业务项目文档时）；必须记录 `CP3: N/A（docs 子类型豁免）`  
- ⚠️ **控制面 / Skill / 规范包变更**（如本仓库改 skills）走 `dev.default`，**不享受**本豁免  
- CP2 简化为**文档大纲确认**（业务文档内容任务；控制面任务仍完整技术方案）

## 目标文档分流

当任务属于“契约驱动型文档”且已锁定为技术契约（非用户站 narrative）时，优先先冻结目标文档，再让后续实现或联动产物围绕它落地。  
用户侧 **reference** 可由 `user-manual-authoring` **编排** 本 Skill 的 light-api，但 Owner 仍是用户站。

### 何时视为契约驱动型文档

满足任一条件即可：

1. 文档本身定义了对外 API 契约
…

Read the whole file at its exact version.

How to install

The exact contents, by fingerprint

mdr add devcodex-labs/devcodex/dev-docs@sha256:cf3dbb9aeb2accea

The line at the top of this page pins the label git:20260908.6caf1bf, which is what most people want. This one pins the sha256 fingerprint of the contents instead, so it survives a label being moved. Either way the exact version is written to mdr.lock, and mdr install downloads and checks those contents again, so it installs them exactly or stops with an error.

Badge

[![mdr](https://markdownregistry.com/badge/art_bmwadvvuxgslfhgc.svg)](https://markdownregistry.com/a/art_bmwadvvuxgslfhgc)

5 badge image fetches in 30 days. What the badge shows.

Versions

The registry has recorded 2 versions of this file, between Jul 30, 2026 and Sep 8, 2026, about one every 40 days.

version	committed	commit	size	audit
git:20260908.6caf1bf latest	2026-09-08	6caf1bf	9,470 B	A	view · diff
git:20260730.6ee304a	2026-07-30	6ee304a	9,377 B	A	view

Audit of the latest version

A 17 of 17 checks passed. Fixed automatic checks with no AI involved, so the same checks give the same answer every run.

pass: Frontmatter block present
pass: Frontmatter declares a name
pass: Frontmatter declares a description
pass: Size between 200 bytes and 200 KB (9470 bytes)
pass: No zero-width or bidi control characters
pass: No instruction hidden inside an HTML comment
pass: No link to an exfiltration or paste host
pass: No credential-shaped string
pass: No instruction to send local credentials anywhere
pass: No text hidden with inline styles
pass: No prompt-injection phrasing
pass: No curl or wget piped into a shell
pass: No recursive delete of root, home or parent
pass: No instruction to read or print local credentials
pass: No base64 blob over 200 characters
pass: No link to a raw IP address
pass: No script tag

Source

GitHub

devcodex-labs/devcodex · 432 stars · license AGPL-3.0 · pushed 2026-10-27 · branch main

API

GET https://markdownregistry.com/api/v1/artifacts/art_bmwadvvuxgslfhgc
GET https://markdownregistry.com/api/v1/resolve?ref=devcodex-labs/devcodex/dev-docs
GET https://markdownregistry.com/api/v1/blob/cf3dbb9aeb2acceadad78bf3bc5b19a9046e720f17289bd4578ae627f3528bc3

Your AI assistant does the legwork. You hear about the deals worth your word. Hand yours the standing instructions at modelranch.com and it joins the network that reads files like this one.

Guides: the SKILL.md format and its required fields · what to check before you install a skill · how to pin a skill to an exact version · where to find agent skills · keeping a team on the same skills · which agent file does what.

More from devcodex-labs/devcodex

accessibility-i18n SKILL.md skill

devcodex-labs/devcodex · content/skills/accessibility-i18n/SKILL.md · 无障碍与国际化专家 Owner — 当任务涉及可访问性、键盘操作、焦点、屏幕阅读器、ARIA、语言地区、本地化、RTL、翻译资源、用户可见文案或多语言文档时使用；要求把包容性体验和本地化验证绑定到真实用户路径。