dev-docs

Solid

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

AI & Automation 263 stars 34 forks Updated 2 days ago AGPL-3.0

Install

View on GitHub

Quality Score: 84/100

Stars 20%
81
Recency 20%
100
Frontmatter 20%
70
Documentation 15%
100
Issue Health 10%
80
License 10%
100
Description 5%
100

Skill Content

# Dev Docs Skill ## 触发条件 用户要求编写/更新**技术类**文档:API/契约说明、架构文档、开发指南、迁移**实现**说明、通用技术 Markdown 等。 > ⛔ **入口分流(DocsAudienceIntent,强制)** > 写文档任务须先判定 `docsAudience` + `docsSurface`(`scripts/lib/docs-audience-intent.js` / registry `docs-audience-intent`): > - `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` → **阻断**;ambiguous 须唯一推荐消歧;multi 须拆任务。 > - 仅当受众已是技术读者且 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 契约 2. 文档面向前端联调、页面调用或外部调用方 3. 若不先冻结文档,后续实现容易产生接口或交互漂移 ### 三种目标文档模式 | 模式 | 适用场景 | 产物形态 | |------|---------|---------| | `light-api` | 普通接口说明、调用方说明、轻量联调文档 | Markdown 轻量 API 文档 | | `frontend-api` | 前端联调、页面/模块接口说明、字段映射说明 | Markdown 前端接口文档 | | `general-doc` | 架构文档、开发指南、迁移指南、治理说明、运行手册 | Markdown 通用文档 | ## REA...

Details

Author
devcodex-labs
Repository
devcodex-labs/devcodex
Created
5 months ago
Last Updated
2 days ago
Language
JavaScript
License
AGPL-3.0

Similar Skills

Semantically similar based on skill content — not just same category