skills/doc-writer/SKILL.md
帮助用户编写、管理文档:项目概述文档(project.md)、UI/UE规范文档(ui-ue-spec.md)、需求文档(req-xxx.md)、功能设计文档(feat-xxx.md)、模型设计文档(model-xxx.md)、接口设计文档(api-xxx.md)、静态 HTML 页面、变更记录文档(chg-project.md, chg-ui-ue-spec.md, chg-req-xxx.md, chg-feat-xxx.md, chg-api-xxx.md, chg-model-xxx.md)、开发任务文档(task-xxx.md)。执行编码任务时,同步更新开发任务文档 (task-xxx.md),帮助用户管理开发任务的进度。
npx skillsauth add chanjarster/skills doc-writerInstall this skill globally with one command. Works with Claude Code, Cursor, and Windsurf.
3 of 9 scanners reported clean
Some scanners were skipped, did not run, or reported a non-clean status. Review each row below.
按照规范管理和组织软件开发过程中需要的文档,同时也对开发任务进行文档化管理。
所有文档位于项目根目录的 project-docs 目录下,目录结构:
project-docs/
├─ latest/ # 最新文档目录,存放的是 Current truth
│ ├─ [设计主题]/ # 设计主题目录,里面存放各类文档
│ │ ├─ req-xxx.md # 需求文档
│ │ ├─ feat-xxx.md # 功能设计文档
│ │ ├─ model-xxx.md # 模型设计文档
│ │ ├─ api-xxx.md # 接口设计文档
│ │ └─ static-html/ # 静态HTML原型目录
│ │ └─ page-xxx.html # 静态 html 页面
│ ├─ ui-ue-spec.md # UI/UE规范
│ └─ project.md # 项目概述文档
├─ changes/ # 存放历次的变更记录
│ └─ [变更主题]/ # 变更记录目录
│ ├─ chg-req-xxx.md # 需求变更文档
│ ├─ chg-feat-xxx.md # 功能设计变更文档
│ ├─ chg-model-xxx.md # 模型设计变更文档
│ ├─ chg-api-xxx.md # 接口变更设计文档
│ ├─ chg-project.md # 项目概述变更文档
│ ├─ chg-ui-ue-spec.md # UI/UE规范变更文档
│ └─ static-html/ # 静态HTML原型目录
│ └─ chg-page-xxx.html # 变更后的静态 html 页面
└─ tasks/ # 开发任务文档目录
├─ completed/ # 已完成任务目录
└─ task-xxx.md # 进行中的开发任务文档
路径: project-docs/latest/project.md
文档内容要求:见 project.md
路径: project-docs/latest/ui-ue-spec.md
文档内容要求:见 ui-ue-spec.md
目录:project-docs/latest/[设计主题]
路径:project-docs/latest/[设计主题]/req-xxx.md
文档内容要求:见 req-xxx.md
路径:project-docs/latest/[设计主题]/feat-xxx.md
文档内容要求:见 feat-xxx.md
功能点的设计,包括功能描述、功能实现流程、业务规则、使用角色、界面设计要求等关键内容。
路径:project-docs/latest/[设计主题]/code-xxx.md
文档内容要求:见 code-xxx.md
路径:project-docs/latest/[设计主题]/static-html/page-xxx.html
静态的 HTML 原型页面。
路径:project-docs/changes/[变更主题]/chg-project.md
文档内容要求:见 chg-project.md
路径:project-docs/changes/[变更主题]/chg-ui-ue-spec.md
文档内容要求:见 chg-ui-ue-spec.md
路径:project-docs/changes/[变更主题]/chg-req-xxx.md
文档内容要求:见 chg-req-xxx.md
路径:project-docs/changes/[变更主题]/chg-feat-xxx.md
文档内容要求:见 chg-feat-xxx.md
路径:project-docs/changes/[变更主题]/chg-code-xxx.md
文档内容要求:见 chg-code-xxx.md
路径:project-docs/changes/[变更主题]/static-html/chg-page-xxx.html
变更后的静态 HTML 原型页面。
路径:project-docs/tasks/task-xxx.md
文档内容要求:见 task-xxx.md
在编码过程中,适时在任务文档 task-xxx.md 中更新工作进度。
路径:project-docs/tasks/completed/task-xxx.md
当任务完成后,把任务文档移动到 project-docs/tasks/completed/ 下。
documentation
将本地 Markdown 文档批量同步到钉钉知识库,支持新建和增量更新。 当用户需要将本地文档、目录同步或推送到钉钉知识库时使用,包括但不限于: "把 docs/ 同步到钉钉知识库"、"批量上传 markdown 到钉钉"、 "将这些文档推到知识库"、"帮我把本地 note 同步到钉钉上"、 "/dd-sync"。依赖 dws skill 和 dws 命令操作钉钉知识库。
development
管理项目情报(Project Information)文档系统。当需要创建、读取、更新或导航(搜索)项目文档时使用,包括业务知识(需求文档、操作手册)、技术文档(架构、开发环境、代码地图、研究记录)、UI设计(设计图、切图)、规范文档(git 规范、代码规范、示例)和任务日志。在项目初始化、编写需求/技术/UI/规范文档、管理开发任务、执行开发任务、或其他需要了解项目上下文时触发。
development
Maintainer-only workflow for handling GitHub Secret Scanning alerts on OpenClaw. Use when Codex needs to triage, redact, clean up, and resolve secret leakage found in issue comments, issue bodies, PR comments, or other GitHub content.
development
Maintainer workflow for OpenClaw releases, prereleases, changelog release notes, and publish validation. Use when Codex needs to prepare or verify stable or beta release steps, align version naming, assemble release notes, check release auth requirements, or validate publish-time commands and artifacts.