mcpField
D
docs-update

docs-update

github.com/hiromaily开发12837 次安装27 周前更新
代码仓库

关于 docs-update

docs-update 是用于修改文档的开发技能，强调编辑前确认单一事实来源（SSOT），并指导交叉引用检查、Markdown 格式和避免信息重复。

主要功能

  1. 01识别 SSOT 文档
  2. 02检查重复信息
  3. 03指导 Markdown 格式
  4. 04核对链接和交叉引用
  5. 05提供文档检查清单

适用场景

  1. 01编辑指南或参考文档
  2. 02更新 SSOT 及其引用
  3. 03检查文档链接和一致性

安装

复制下面的命令，在终端中运行。

$npx skills add https://github.com/hiromaily/go-crypto-wallet --skill docs-update

安装后在 Claude Code 中输入/docs-update确认已加载。

详细介绍

文档更新工作流

用于更新文档并考虑 SSOT 的工作流。

前提条件

  • 分支、提交和 PR 工作流请使用 git-workflow Skill。
  • 编辑任何文档前，请先了解 SSOT 结构。

SSOT 说明

重要：编辑文档前，请确认该文件是否为 SSOT，或是否引用了 SSOT。

SSOT 位置
类别SSOT 位置描述
Agent 行为AGENTS.md所有 Agent 的入口点
Agent 指令设计docs/ai/design.md命令/Skill/规则架构
标签定义docs/guidelines/task-classification.md所有标签类型及其含义
标签 → Skill 映射.claude/skills/label-context-mapping/操作路由
编码规范docs/guidelines/coding-conventions.md代码风格规则
安全规则docs/guidelines/security.md安全要求
测试标准docs/guidelines/testing.md测试要求
工作流docs/guidelines/workflow.md开发工作流
SSOT 规则
  1. 如果编辑 SSOT 文件：请谨慎更新，因为其他文件会引用它
  2. 如果编辑非 SSOT 文件：确保它引用 SSOT，不要重复信息
  3. 如果信息冲突：以 SSOT 为准；更新引用该信息的文件

适用文件

路径类型描述
AGENTS.mdSSOTAgent 行为入口点
ARCHITECTURE.mdSSOT系统架构
docs/guidelines/SSOT项目指南和标准
docs/design/参考设计文档
docs/chains/参考特定链的文档
docs/ai/task-contexts/上下文特定任务的流程
internal/AGENTS.md范围限定的 SSOT内部包指南
pkg/AGENTS.md范围限定的 SSOT公共包指南

文档层级

AGENTS.md (entry point)
    │
    ├─ docs/ai/design.md (instruction system design)
    │
    ├─ docs/guidelines/ (guidelines and standards)
    │   ├─ task-classification.md (label definitions, SSOT)
    │   ├─ coding-conventions.md
    │   ├─ security.md
    │   ├─ testing.md
    │   ├─ workflow.md
    │   ├─ architecture.md
    │   ├─ code-generation.md
    │   └─ ...
    │
    └─ docs/ai/task-contexts/ (task-specific context)
        ├─ bug-fix.md, feature-add.md, etc.
        └─ chains/ (chain-specific)

工作流

1. 确定文档类型

编辑前，请确认：

  • 该文件是否为 SSOT？
  • 该文件是否引用 SSOT？
  • 可能会影响哪些其他文件？
2. 检查重复信息

如果你要添加的信息已在其他位置存在：

  • 找到 SSOT 位置
  • 添加引用，而不是重复内容
3. 进行更改

遵循 Markdown 风格指南：

  • 使用 ATX 风格标题（#、##、###）
  • 各章节之间留一个空行
  • 代码块需指定语言
  • 使用表格呈现结构化数据
  • 在文档中使用相对链接
4. 验证交叉引用

更改后：

  • 链接有效
  • SSOT 引用准确
  • 没有重复信息
  • 格式一致

Markdown 风格

标题
# Top Level (document title)

## Section

### Subsection
代码块

务必指定语言：

```go
func example() {}
```

make go-lint


### Tables

Use tables for structured data:

```markdown
| Column 1 | Column 2 |
|----------|----------|
| Value 1  | Value 2  |
链接
  • 使用相对链接：[link](../path/to/file.md)
  • 移动文件后，请验证链接是否有效
  • 重命名时更新交叉引用

自查清单

  • 已确认 SSOT 位置（如适用）
  • 没有重复信息
  • 引用指向正确的 SSOT
  • Markdown 渲染正确
  • 链接有效
  • 格式一致
  • 表格对齐正确

提交与 PR

提交时使用 git-workflow 技能：

  • 提交类型：docs
  • 范围：可选（或目标区域：btc、eth、standards 等）

示例：docs(standards): update coding conventions for error handling

相关内容

评论

支持 Markdown