cold-reader

GitHub

指导撰写面向无历史背景读者的文档,如指南、README、PR描述等。要求仅描述当前状态,避免提及读者不可见的迭代历史或废弃内容,确保所有引用均可查证,提升文档的可读性与自洽性。

developer-skills/cold-reader/SKILL.md telepath-computer/television

Trigger Scenarios

撰写或编辑 README、指南、PR 描述、规范文档 需要移除迭代历史框架和过时行为引用的请求 审查文档是否包含读者无法看到的上下文

Install

npx skills add telepath-computer/television --skill cold-reader -g -y
More Options

Non-standard path

npx skills add https://github.com/telepath-computer/television/tree/main/developer-skills/cold-reader -g -y

Use without installing

npx skills use telepath-computer/television@cold-reader

指定 Agent (Claude Code)

npx skills add telepath-computer/television --skill cold-reader -a claude-code -g -y

安装 repo 全部 skill

npx skills add telepath-computer/television --all -g -y

预览 repo 内 skill

npx skills add telepath-computer/television --list

SKILL.md

Frontmatter
{
    "name": "cold-reader",
    "description": "Write or edit guides, READMEs, PR descriptions, specs, proposals, commit bodies, and code comments for readers without the development history. Use for \"cold-reader policy\", \"forward-looking\" documents, or requests to remove iteration-history framing and references to \"old\", \"previous\", \"deprecated\", or \"removed\" behavior the reader cannot see."
}

Cold-reader policy

Write for someone who sees the document but did not attend the design conversation or watch implementation iterate. Describe what exists. Every reference should be findable in the document, its visible diff, or the current code or system; otherwise it makes the reader wonder about context they should not need.

Establish what the reader can see

  • Guides and READMEs: a user who installed today and knows no prior release.
  • PR descriptions: a reviewer with the final squash diff against the PR's actual base branch and that base's state, without intermediate commits.
  • Specs and proposals: an implementer or reviewer reading in isolation, without chat transcripts.
  • Commit messages: someone using git log -p or git blame, with this commit's diff and message.
  • Code comments: a maintainer reading the function in isolation, perhaps years later or after refactoring.

Ask: can this reader find every thing the text references? A fact known only from your reasoning, chat, or abandoned work is unavailable even if it feels established to you.

Describe the present and make comparisons visible

Describe what is, without narrating what was considered, renamed, or removed unless the reader can see it. For phrases such as "Y not X", "X is removed", "instead of X", or "X is no longer supported", check whether X is visible. If it is not, state Y directly.

Comparisons work when both sides are available:

  • "Removed flag --foo" in a PR when the flag exists in the base and its deletion is in the diff.
  • An export rename in a migration guide or changelog whose purpose is to bridge versions.
  • A comment comparing behavior with another real, current function.
  • A spec referring to an earlier section of itself.

A squash reviewer cannot see an implementation abandoned during the branch's development. Compare against the base, even for a branch with a long history.

Explain useful rationale positively: "Library X provides Y." Unshipped library W adds no context to that statement. Rationale that requires discussing unshipped alternatives belongs in design or architectural decision records, internal notes, or the incremental commit recording the choice. Those records explicitly preserve history; user docs and PR bodies do not serve that purpose.

Migration sections may discuss prior behavior because their readers need it. Feature descriptions, API references, and conceptual overviews in the same document should still describe the present.

Self-audit before publishing

Mechanically search the draft for these markers:

  • not, no longer, not yet, not currently
  • instead of, rather than, in place of, as opposed to
  • previously, formerly, used to, was, had been
  • new, now, this change, this update, we now
  • removed, deprecated, replaced, dropped
  • we considered, we explored, we tried, we chose
  • instead, however

Inspect each hit for an invisible comparison; these words are signals, not automatic violations. Rewrite references the reader cannot resolve as statements of what exists.

Then read end-to-end. Search misses implicit baselines and structures that assume the reader watched the work. Check whether someone opening the document today would wonder about something unavailable to them. Repeated rewrites often leave stale "new system" framing. When replacing a paragraph, inspect the surrounding structure too; changing individual words does not repair an argument built around an unseen alternative.

Version History

  • a8e73fb Current 2026-10-18 15:27

Same Skill Collection

developer-skills/deploy-tv-admin-guide/SKILL.md
developer-skills/deploy-tv-update-channel/SKILL.md
developer-skills/logical-merging/SKILL.md
developer-skills/plain-english-full/SKILL.md
developer-skills/plain-english/SKILL.md
developer-skills/pr-writing/SKILL.md
developer-skills/tvdev-contribute/SKILL.md
developer-skills/tvdev-review/SKILL.md
developer-skills/tvdev-setup/SKILL.md
packages/skills/skills/tv-calendar/SKILL.md
packages/skills/skills/tv-sidebar-view/SKILL.md
packages/skills/skills/tv-table/SKILL.md
packages/skills/skills/tv-tasks/SKILL.md
developer-skills/complexity-inoculation/SKILL.md

Metadata

Files
0
Version
a8e73fb
Hash
6ac274c8
Indexed
2026-10-18 15:27

홈 - 위키
Copyright © 2011-2026 iteam. Current version is 2.155.2. UTC+08:00, 2026-10-19 13:25
浙ICP备14020137号-1