SKILL

confluence-explain-doc

Write and publish a Confluence page (or Jira/report text) that explains a bug's cause, logic, and fix so a first-time reader understands it. Code-capture first: real source lines with red/green/blue line highlights and line-numbered captions, one section per problem, how problems connect, git blame plus the original reason for each cause, details folded. Use for "write this up in Confluence", "explain the root cause", "I don't understand this explanation", "progressive disclosure", 컨플 정리, 설명 문서, 원인 설명.

原文 · 暂不支持此原文语言

适用对象:软件开发与测试。自动收录 · 待核查。

原作者说明节选

从固定版本的 SKILL.md 提取,保留原文语言。以下内容属于作者说明,本站尚未验证安装、兼容或运行结果。

查看英文原文

原文涵盖的主题

  • confluence-explain-doc
  • 0. Load the domain profile first
  • 1. Page structure (fixed order)
  • 2. Code captures
  • 3. Cause rows: blame plus original background
  • 4. Noise removal (before every publish)
  • 5. Publish and check
  • Writing

Goal: a reader who opens the page once can explain the problem to someone else. Real code carries the explanation; prose stays minimal. Company/project specifics (site, space, branch names, glossary, label language, token location) live outside this skill so the skill stays portable. Read the first one that exists: 1. the file in $EXPLAINDOCDOMAIN 2. /.explain-doc/domain.md 3. /docs/agents/explain-doc-domain.md No profile: ask for the Confluence site, space key, and the "before" ref (usually the production branch). Template: references/domain-profile.md. No format headings ("Summary", "Overview", "TL;DR", "Click to expand"). Headings name the content. 1. Opening paragraph (no heading, 2-3 sentences): how many problems, the shared object they touch (one table, one value), and how they differ (e.g. one writes the wrong value, the other reads it and sends it). 2. One section per problem, numbered in the priority the user sets ( Problem N. : ). When you renumber, fix every "Problem N" reference too. Four lines ( , keyword — one plain sentence): symptom → cause → evidence it really happened or original background (with blame) → fix (commits). Define each term the first time it appears;

这里只展示节选,请以完整原文和当前要求为准。

来源仓库
cskwork/skills
源文件
skills/productivity/confluence-explain-doc/SKILL.md
固定版本
3cbcf7c00b169da79fee5e91699440729b0eb84b
阅读完整原作者说明 ↗

来源与内容状态

本条为自动发现的元数据,尚未完成人工文档核查;适用性与运行结果待核查。

原作者:cskwork/skills · 原作者仓库元数据。文档核查:未核查。最近来源检查:2026-11-12T03:01:42.951Z。

分类由名称、说明与路径规则生成,分类不代表已核实适配。

许可与权利归属

MIT。第三方内容及版权归原作者,使用条件以原文为准。

许可原文 ↗

本站没有因同步、复制或用户自报成功而将资源标为运行验证通过。

限制与注意事项

  • 元数据收录不代表本站已经安装、适配、实测或进行安全审查。