Skip to content
Skills Library
Documents & office · Writing

docs-writer

/docs-writer

撰写、补全、重构或精简项目 Markdown 文档,包括 README.md、部署文档 deployment.md、架构文档 architecture.md、技术栈文档 tech-stack.md、开发任务清单 tasks.md、数据库设计文档 database.md,以及技术教程、API 使用说明和变更日志。基于项目事实,按文档职责组织内容,文字简洁干练、逻辑清晰、条理分明。用户要求写项目文档、整理部署步骤、说明系统架构、梳理技术栈、拆分开发任务或记录数据库设计时使用;仅提到文件名、读取文档或执行部署时不触发。

Repository
xskills ↗
Licence
MIT
Last repository change
14.11.2026

Assessment and security

90/ 100Class: good
Format25 / 25
Frontmatter with name and description, valid name, description up to 1,024 characters, name matching the folder.
Discoverability25 / 25
Description explains when to use the skill, has a reasonable length and uses third person.
Content25 / 35
At least 150 words and at most 500 lines, headings, step lists, examples or code.
Hygiene15 / 15
No placeholders such as TODO, no Windows paths, with a licence.
Riskno signals detected in the scan
Files in this package
3
Scripts
0
HTML comments
0
URLs in SKILL.md
0
Deprecation

No signals detected. Repository changed on 14.11.2026, without references to retired models or APIs.

Licence

MIT, open: use and modify while retaining author attribution.

What it does and when to use it

撰写、补全、重构或精简项目 Markdown 文档,包括 README.md、部署文档 deployment.md、架构文档 architecture.md、技术栈文档 tech-stack.md、开发任务清单 tasks.md、数据库设计文档 database.md,以及技术教程、API 使用说明和变更日志。基于项目事实,按文档职责组织内容,文字简洁干练、逻辑清晰、条理分明。用户要求写项目文档、整理部署步骤、说明系统架构、梳理技术栈、拆分开发任务或记录数据库设计时使用;仅提到文件名、读取文档或执行部署时不触发。

Original author description

撰写、补全、重构或精简项目 Markdown 文档,包括 README.md、部署文档 deployment.md、架构文档 architecture.md、技术栈文档 tech-stack.md、开发任务清单 tasks.md、数据库设计文档 database.md,以及技术教程、API 使用说明和变更日志。基于项目事实,按文档职责组织内容,文字简洁干练、逻辑清晰、条理分明。用户要求写项目文档、整理部署步骤、说明系统架构、梳理技术栈、拆分开发任务或记录数据库设计时使用;仅提到文件名、读取文档或执行部署时不触发。

How it works

  1. 任务边界
  2. 文档职责与按需读取
  3. 工作流程
  4. README 头部规则
  5. 验收清单
Original SKILL.md headings · 77 lines, 184 words
SKILL.md preview
---
name: docs-writer
description: 撰写、补全、重构或精简项目 Markdown 文档,包括 README.md、部署文档 deployment.md、架构文档 architecture.md、技术栈文档 tech-stack.md、开发任务清单 tasks.md、数据库设计文档 database.md,以及技术教程、API 使用说明和变更日志。基于项目事实,按文档职责组织内容,文字简洁干练、逻辑清晰、条理分明。用户要求写项目文档、整理部署步骤、说明系统架构、梳理技术栈、拆分开发任务或记录数据库设计时使用;仅提到文件名、读取文档或执行部署时不触发。
---

# 技术文档写作(docs-writer)

产出事实准确、结构清楚、能指导操作或决策的 Markdown 文档。默认使用简体中文;沿用项目术语、文件名与代码标识。专业性来自准确和可执行,不靠篇幅、术语或装饰。

## 任务边界

- 只创建或修改用户请求的文档,不因为支持六类文档就一次生成全套。
- 局部修改保留原有结构、语言、头部样式与无关内容;明确要求重写时才调整整体结构。
- 路径以用户指定和仓库约定为先。没有约定时,README 放根目录,其他项目文档放 `docs/`,沿用下表文件名。
- 仅要草稿时直接交付 Markdown;在仓库内明确要求编写或更新文档时写入对应文件。
- API 契约规范使用 api-docs;PRD 使用 prd-creator。代码注释、提交信息、PR 描述不套用本流程。
- 编写部署、架构或数据库文档不等于授权部署、改代码或变更数据库;已有操作授权按原范围执行。

## 文档职责与按需读取

先确定读者要完成的事,再读取 [文档结构规范](references/templates.md) 中对应的小节,不加载无关模板。

| 文档 | 回答的问题 | 结构规范 |
| --- | --- | --- |
| `README.md` | 项目做什么,如何开始,去哪里查细节 | [README](references/templates.md#readme) |
| `deployment.md` | 如何部署、验证、更新和恢复 | [部署文档](references/templates.md#部署文档) |
| `architecture.md` | 系统如何组成、协作,边界和取舍是什么 | [架构文档](references/templates.md#架构文档) |
| `tech-stack.md` | 使用哪些技术,版本约束和用途是什么 | [技术栈文档](references/templates.md#技术栈文档) |
| `tasks.md` | 要做什么、先后依赖、如何判定完成 | [开发任务清单](references/templates.md#开发任务清单) |
| `database.md` | 数据如何组织、约束、关联和演进 | [数据库设计文档](references/templates.md#数据库设计文档) |
| 教程、API 使用说明、变更日志 | 完成具体任务、调用能力或了解升级影响 | [其他技术文档](references/templates.md#其他技术文档) |

同一事实只在主文档中完整维护,其他文档保留必要摘要并链接。例如 README 链接部署步骤,架构文档链接技术版本和表结构。只链接已存在或本次确实创建的文档。

## 工作流程

### 1. 确定范围

识别目标文件、读者、使用场景,以及本次是新建、局部修订还是整体重写。先查项目约定和已有文档;仅当缺失信息会实质改变结果且无法从上下文确定时,集中询问。信息充分时直接执行。

### 2. 核实事实

- 按主题检查相关源码、配置、依赖清单与锁文件、部署脚本、数据库模型与迁移、测试及现有文档,不无差别遍历仓库。
- 用当前实现说明行为,用配置说明参数,用锁文件说明解析版本,用实际运行记录说明验证结果;旧文档作为线索,不直接当作事实。
- 区分已实现、拟议方案和未核实信息。用户要求未来设计时明确标为方案,不写成现状;不编造功能、性能、设计理由、负责人或进度。
- 来源冲突时核对适用版本与环境;无法消除的关键冲突简要说明,不静默选择。仓库配置不等于生产环境实际状态。
- 非关键缺口省略;关键缺口集中说明事实缺口和影响,不用占位内容伪装成完整文档。有阻塞时继续完成独立部分。
- 涉及外部产品的当前版本、兼容性或弃用行为时,核验对应版本的官方资料;不为普通措辞修改联网,不把项目版本擅自升级为最新版。

### 3. 组织内容

依据对应文档规范保留完成任务所需的章节。先给定位、结论或适用范围,再给操作、结构或约束;按依赖和执行顺序组织内容。无内容、无依据、不适用的章节直接删去,不填空壳。

### 4. 写作与压缩

- 按 [风格指南](references/style-guide.md) 写短句、具体动作和明确条件。每段提供事实、操作、约束、原因或验收标准,删除不增加信息的句子。
- 步骤用编号列表,并列要点用无序列表,字段与对比用表格;简单结论直接用段落。
- 只在操作需要时提供命令、配置或代码,写清执行目录、前提和成功判据;预期结果不冒充实测输出。
- 图表只用来解释难以用短文说清的关系或流程,组件、名称和方向与正文及证据一致。
- 不重复背景、命令含义和章节结论,不用宣传语、口号、客套话或空泛的“最佳实践”填充正文。

### 5. 核对与交付

按下方清单检查并修正问题。交付时只说明修改文件、关键变化、已验证内容和实质性限制,不复述整篇文档。写入文件后不再在聊天中粘贴全文,除非用户要求。

## README 头部规则

仅在新建 README 或用户明确要求调整头部与徽章时,读取并应用 [README 头部与徽章](references/style-guide.md#readme-头部与徽章):按事实添加少量徽章、统一 Shields.io 样式并居中头部。用户或项目指定版式优先。一般润色、补充段落和其他文档不触发头部改造。

## 验收清单

- [ ] 文档回答目标读者的问题,章节顺序清晰,没有重复内容、空章节和未替换的模板提示。
- [ ] 功能、命令、配置、版本、路径、任务状态和数据结构均有依据;方案与现状明确区分。
- [ ] 操作包含必要前提和可观察的成功判据;部署、迁移等关键操作说明失败处理或恢复边界。
- [ ] 新增或修改的本地链接、锚点、文件路径与跨文档术语一致;外部链接按本次变更范围核验。
- [ ] 已核对对应文档的专有要求;局部修改未引入无关重排或样式变化。
- [ ] 代表性示例在安全、具备条件且已有授权时验证;否则静态核对并注明未执行,未将检查结果写成生产验收。
- [ ] 无真实密钥、令牌、个人数据和未经脱敏的生产配置。

检查通过即结束。不为验证写作而执行部署、重启服务、迁移、删除数据或权限提升。遇到环境或权限阻塞,停止该项重试,说明未验证部分,继续不受影响的检查。
Files in this package (3)
  • SKILL.md 7 KB
  • references/style-guide.md 7 KB
  • references/templates.md 12 KB

Versions

RepositoryScoreLicence
This page · xiongxianzhu/xskills90MIT
google-gemini/gemini-cli100Apache-2.0
kensaurus/cursor-kenji100MIT
yamcodes/arkenv100MIT
thisiskurubaran/DevSecOps100MIT
tech-leads-club/agent-skills90MIT
zjunlp/skills90MIT

Database snapshot: 13.11.2026 · package version c049f84b2f32 (SHA-256 digest of the entire package)

Downloads in the last 30 days: 0 · ranking

Report a problem with this skill: harmful content, incorrect descriptions or an author’s removal request.

Similar skills

  • 90ns-docs-writer
    (NS) Human-facing project docs — README, docs/ guides, runbooks, contributor markdown. Use whenever the user asks for documentation, README updates, how-to guides, or docs/ content — even if they say \"explain how to use\" instead of \"write docs\". Do NOT use for code comments,…
  • 85write-the-docs
    Write or edit project documentation. Use when writing a README, design doc, or module doc.
  • 100markdown-writer
    Generates well-structured technical documentation in Markdown. Use when a user asks to write docs, create a README, document an API, write a how-to guide, generate technical documentation, create a changelog, write a project wiki, or produce any structured Markdown content.…
  • 100tech-documentation
    技术文档编写技能,涵盖 API 文档、架构文档、部署指南和各种技术写作最佳实践。使用此技能创建技术文档、编写 API 文档、创建架构设计文档,或需要部署和运维手册模板时使用。
  • 100documenting
    Writes or updates project documentation (README, docs/, docstrings, decision log). Use when behaviour, setup, or architecture changes, or when asked to document something.
  • 90dev-blueprint
    分析 GitHub 项目或本地代码库,以此为参考生成从零开发一个新项目的完整文档套件(产品手册、开发文档、架构文档、目录结构文档、设计规范文档、数据库设计文档、开发步骤计划、实施步骤文档、部署文档),并附带 AGENTS.md 指引 AI 开发工具执行开发。 当用户提供一个参考项目(GitHub 链接或本地路径),要求生成开发计划、开发文档、项目蓝图、功能拆解、实施步骤,或要求基于某个项目从零开发类似项目时使用。 允许用户指定技术栈替换、功能增减、聚焦特定模块。 适用于中文请求,例如"参考这个项目生成开发计划"、"基于这个 GitHub…

Feedback and reports

Your message goes to Bartosz Sokoliński. An email address is needed only for a reply. See the privacy policy.