dev-docs

Solid

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

AI & Automation 418 stars 44 forks Updated 1 weeks ago AGPL-3.0

Install

View on GitHub

Quality Score: 83/100

Stars 20%
87
Recency 20%
90
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
1 weeks ago
Language
JavaScript
License
AGPL-3.0

Similar Skills

Semantically similar based on skill content — not just same category

AI & Automation Listed

dev-docs

开发文档自动化生成和维护工具。在完成需求开发后自动生成需求文档(PRD)和API接口文档,在代码更新后自动维护CHANGELOG和API CHANGELOG。触发时机:用户说"生成文档"、"写文档"、"更新文档",或提到PRD、API文档、changelog、需求文档时自动触发。

1 Updated yesterday
Hautran11325
AI & Automation Listed

doc-gov

文档体系治理知识库(code-as-docs,文档即代码):指导项目建立契约在代码、文档是投影的工程文档体系。 AGENTS.md 极简五节合同(Commands/Must/Must not/Read first/环境)、ADR 架构决策记录(管不可逆技术选择, 状态机 proposed 到 accepted 到 superseded)、REQ 需求登记(draft 到 implemented 带 trace 回填)、 生成投影纪律(文档是投影非真相,禁止第二真相)、agent 渐进检索面(llms.txt 式索引到模块到源码)、 diary 日记与 research 研究档案、六态事实标记;三栈机制对照(Rust docstring 式 /// 与 cargo doc 与 aidoc、 Python docstring 与 MkDocs、TypeScript TSDoc 与 API Extractor)。触发后先读本文件「意图路由」定位,再渐进检索 references/。 Use when 写 AGENTS 合同,立 ADR 架构决策记录或 REQ 需求,定投影纪律与 API 文档工具链, 管 diary/research 档案,标六态事实,或查 Rust/Python/TypeScript 文档工程约定时。

0 Updated 3 days ago
raystyle
Data & Documents Solid

documentation-specialist

文档专家。专注于技术文档编写、API 文档生成、README 优化和文档维护。提供清晰的文档结构、规范的格式和用户友好的内容。

48 Updated yesterday
huangwb8